public interface GovernanceArtifact
Modifier and Type | Method and Description |
---|---|
void |
addAssociation(String associationType,
GovernanceArtifact attachedToArtifact) |
void |
addAssociation(String associationType,
String artifactId) |
void |
addAttribute(String key,
String value)
Adding an attribute to the artifact.
|
void |
addBidirectionalAssociation(String forwardType,
String backwardType,
GovernanceArtifact attachedToArtifact) |
void |
addTag(String tag) |
void |
addTags(List<String> tags) |
void |
attach(GovernanceArtifact attachedToArtifact)
Attach the current artifact to an another artifact.
|
void |
attach(String artifactId) |
void |
attachLifecycle(String name)
Associates the named lifecycle with the artifact
|
void |
checkLCItem(int order,
String aspectName)
Check the checklist item
|
boolean |
compareTo(GovernanceArtifact artifact) |
void |
detach(String artifactId)
Detach the current artifact from the provided artifact.
|
String[] |
getAllCheckListItemNames(String aspectName)
Retrieve name set of the checklist items
|
String[] |
getAllLifecycleActions(String lifeCycleName)
Get all lifecycle actions for the current state of the lifecycle
|
String[] |
getAllVotingItems()
Retrieve action set which need votes
|
String[] |
getAllVotingItems(String aspectName)
Retrieve action set which need votes
|
Map<String,List<String>> |
getAssociatedArtifactIds() |
Map<String,List<GovernanceArtifact>> |
getAssociations() |
String |
getAttribute(String key)
Returns the attribute of a given key.
|
String[] |
getAttributeKeys()
Returns the available attribute keys
|
String[] |
getAttributes(String key)
Returns the attribute values for a key.
|
Map<String,String> |
getCurrentStateDuration(String artifactID,
String lcName)
This method is used to get a lifecycle's current state duration information.
|
GovernanceArtifact[] |
getDependencies()
Get dependencies of an artifacts.
|
GovernanceArtifact[] |
getDependents()
Get dependents of an artifact.
|
String |
getId()
Returns the id of the artifact
|
String |
getLifecycleName()
Returns the name of the default lifecycle associated with this artifact.
|
String[] |
getLifecycleNames()
Returns the names of the lifecycle associated with this artifact.
|
String |
getLifecycleState()
Returns the state of the default lifecycle associated with this artifact.
|
String |
getLifecycleState(String lifeCycleName)
Returns the state of the lifecycle associated with this artifact.
|
String |
getMediaType()
Returns the media type of the artifact.
|
String |
getPath()
Returns the path of the artifact, need to save the artifact before
getting the path.
|
String[] |
getPropertyKeys()
Returns the available attribute keys
|
QName |
getQName()
Returns the QName of the artifact.
|
void |
invokeAction(String action,
Map<String,String> parameters,
String aspectName)
Promote the artifact to the next state of the lifecycle
|
void |
invokeAction(String action,
String aspectName)
Promote the artifact to the next state of the lifecycle
|
boolean |
isLCItemChecked(int order,
String aspectName)
Check whether the given ordered lifecycle checklist item is checked or not
|
boolean |
isRegistryAwareArtifact() |
boolean |
isVoted(int order)
Check whether the current user voted for given order event
|
boolean |
isVoted(int order,
String aspectName)
Check whether the current user voted for given order event
|
List<String> |
listTags() |
void |
removeAssociation(String artifactId) |
void |
removeAssociation(String associationType,
String artifactId) |
void |
removeAttribute(String key)
Remove attribute with the given key.
|
void |
removeTag(String tag) |
void |
removeTags(List<String> tags) |
void |
setAttribute(String key,
String newValue)
Set/Update an attribute with a single value.
|
void |
setAttributes(String key,
String[] newValues)
Set/Update an attribute with multiple values.
|
void |
setId(String id)
Set the id
|
void |
setQName(QName qName)
Set the QName of the artifact.
|
void |
uncheckLCItem(int order,
String aspectName)
Un-check the checklist item
|
boolean |
uniqueTo(GovernanceArtifact artifact) |
void |
unvote(int order)
Unvote for an action
|
void |
unvote(int order,
String aspectName)
Unvote for an action
|
void |
vote(int order)
Vote for an action
|
void |
vote(int order,
String aspectName)
Vote for an action
|
QName getQName()
void setQName(QName qName) throws GovernanceException
qName
- of the artifactGovernanceException
String getId()
String getMediaType()
void setId(String id)
id
- the idString getPath() throws GovernanceException
GovernanceException
- if an error occurred.String[] getLifecycleNames() throws GovernanceException
GovernanceException
- if an error occurred.String getLifecycleName() throws GovernanceException
GovernanceException
- if an error occurred.void attachLifecycle(String name) throws GovernanceException
name
- the name of the lifecycle to be associated with this artifact.GovernanceException
- if an error occurred.String getLifecycleState() throws GovernanceException
GovernanceException
- if an error occurred.String getLifecycleState(String lifeCycleName) throws GovernanceException
lifeCycleName
- the name of the lifecycle of which the state is requiredGovernanceException
- if an error occurred.void addAttribute(String key, String value) throws GovernanceException
key
- the key.value
- the value.GovernanceException
- throws if the operation failed.void setAttributes(String key, String[] newValues) throws GovernanceException
key
- the keynewValues
- the valueGovernanceException
- throws if the operation failed.void setAttribute(String key, String newValue) throws GovernanceException
key
- the keynewValue
- the valueGovernanceException
- throws if the operation failed.String getAttribute(String key) throws GovernanceException
key
- the keyGovernanceException
- throws if the operation failed.String[] getAttributeKeys() throws GovernanceException
GovernanceException
- throws if the operation failed.String[] getAttributes(String key) throws GovernanceException
key
- the key.GovernanceException
- throws if the operation failed.void removeAttribute(String key) throws GovernanceException
key
- the keyGovernanceException
- throws if the operation failed.GovernanceArtifact[] getDependencies() throws GovernanceException
GovernanceException
- throws if the operation failed.GovernanceArtifact[] getDependents() throws GovernanceException
GovernanceException
- throws if the operation failed.String[] getAllLifecycleActions(String lifeCycleName) throws GovernanceException
lifeCycleName
- lifecycle name of which actions are neededGovernanceException
- throws if the operation failed.void invokeAction(String action, String aspectName) throws GovernanceException
action
- lifecycle action tobe invokedaspectName
- lifecycle name of which action to be invokedGovernanceException
- throws if the operation failed.void invokeAction(String action, Map<String,String> parameters, String aspectName) throws GovernanceException
action
- lifecycle action tobe invokedaspectName
- lifecycle name of which action to be invokedparameters
- extra parameters needed when promotingGovernanceException
- throws if the operation failed.String[] getAllCheckListItemNames(String aspectName) throws GovernanceException
aspectName
- lifecycle name of which action to be invokedGovernanceException
- throws if the operation failed.void checkLCItem(int order, String aspectName) throws GovernanceException
order
- order of the checklist item need to checkedaspectName
- lifecycle name of which action to be invokedGovernanceException
- throws if the operation failed.boolean isLCItemChecked(int order, String aspectName) throws GovernanceException
order
- order of the checklist item need to uncheckedaspectName
- lifecycle name of which action to be invokedGovernanceException
- throws if the operation failed.void uncheckLCItem(int order, String aspectName) throws GovernanceException
order
- order of the checklist item need to uncheckedaspectName
- lifecycle name of which action to be invokedGovernanceException
- throws if the operation failed.String[] getAllVotingItems(String aspectName) throws GovernanceException
aspectName
- Lifecycle nameGovernanceException
- throws if the operation failed.String[] getAllVotingItems() throws GovernanceException
GovernanceException
- throws if the operation failed.void vote(int order, String aspectName) throws GovernanceException
order
- order of the action which need to be votedaspectName
- Lifecycle nameGovernanceException
- throws if the operation failed.void vote(int order) throws GovernanceException
order
- order of the action which need to be votedGovernanceException
- throws if the operation failed.boolean isVoted(int order, String aspectName) throws GovernanceException
order
- order of the action which need to be votedaspectName
- Lifecycle nameGovernanceException
- throws if the operation failed.boolean isVoted(int order) throws GovernanceException
order
- order of the action which need to be votedGovernanceException
- throws if the operation failed.void unvote(int order, String aspectName) throws GovernanceException
order
- order of the action which need to be un votedaspectName
- Lifecycle nameGovernanceException
- throws if the operation failed.void unvote(int order) throws GovernanceException
order
- order of the action which need to be un votedGovernanceException
- throws if the operation failed.String[] getPropertyKeys() throws GovernanceException
GovernanceException
- throws if the operation failed.void attach(GovernanceArtifact attachedToArtifact) throws GovernanceException
attachedToArtifact
- the artifact the current artifact is attached toGovernanceException
- throws if the operation failed.void attach(String artifactId) throws GovernanceException
GovernanceException
void detach(String artifactId) throws GovernanceException
artifactId
- the artifact id of the attached artifactGovernanceException
- throws if the operation failed.void addAssociation(String associationType, GovernanceArtifact attachedToArtifact) throws GovernanceException
GovernanceException
void addAssociation(String associationType, String artifactId) throws GovernanceException
GovernanceException
void removeAssociation(String associationType, String artifactId) throws GovernanceException
GovernanceException
void removeAssociation(String artifactId) throws GovernanceException
GovernanceException
Map<String,List<GovernanceArtifact>> getAssociations() throws GovernanceException
GovernanceException
Map<String,List<String>> getAssociatedArtifactIds() throws GovernanceException
GovernanceException
boolean isRegistryAwareArtifact()
void addTag(String tag) throws GovernanceException
GovernanceException
void addTags(List<String> tags) throws GovernanceException
GovernanceException
List<String> listTags() throws GovernanceException
GovernanceException
void removeTag(String tag) throws GovernanceException
GovernanceException
void removeTags(List<String> tags) throws GovernanceException
GovernanceException
void addBidirectionalAssociation(String forwardType, String backwardType, GovernanceArtifact attachedToArtifact) throws GovernanceException
GovernanceException
boolean uniqueTo(GovernanceArtifact artifact)
boolean compareTo(GovernanceArtifact artifact)
Map<String,String> getCurrentStateDuration(String artifactID, String lcName) throws GovernanceException
artifactID
- lifecycle associated artifacts ID.lcName
- lifecycle name.GovernanceException
Copyright © 2021 WSO2. All rights reserved.