com.sas.metadata.remote
Interface Action

All Superinterfaces:

CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, java.rmi.Remote, Root

public interface Action
extends PrimaryType

An action that will be performed when a stated condition is met.

Attributes of Action are:

• UniqueIdentifier
• ActionType
• InstanceVersion

Associations of Action are:

• ConditionActionSets

Usage

To create an instance of this Action, use the factory create methods.
Example: create a Action with name "Action_Object", in repository "AAAAAAAA".

 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 Action myObject = (Action) factory.createComplexMetadataObject(objectStore, "Action_Object", MetadataObjects.ACTION, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed
 

Behavior

• Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
• When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
• If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:

9.0

Field Summary

static java.lang.String	ASSOCIATION_CONDITIONACTIONSETS_NAME Constant used for the name of the ConditionActionSets association.
static java.lang.String	ATTRIBUTE_ACTIONTYPE_NAME Constant used for the name of the ActionType attribute.
static java.lang.String	ATTRIBUTE_INSTANCEVERSION_NAME Constant used for the name of the InstanceVersion attribute.
static java.lang.String	ATTRIBUTE_UNIQUEIDENTIFIER_NAME Constant used for the name of the UniqueIdentifier attribute.

Fields inherited from interface com.sas.metadata.remote.PrimaryType

ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAME

Fields inherited from interface com.sas.metadata.remote.Root

ASSOCIATION_ACCESSCONTROLS_NAME, ASSOCIATION_CHANGES_NAME, ASSOCIATION_CUSTOMASSOCIATIONS_NAME, ASSOCIATION_DOCUMENTS_NAME, ASSOCIATION_EXTENSIONS_NAME, ASSOCIATION_EXTERNALIDENTITIES_NAME, ASSOCIATION_GROUPS_NAME, ASSOCIATION_IMPLEMENTORS_NAME, ASSOCIATION_KEYWORDS_NAME, ASSOCIATION_LOCALIZEDATTRIBUTES_NAME, ASSOCIATION_NOTES_NAME, ASSOCIATION_PRIMARYPROPERTYGROUP_NAME, ASSOCIATION_PROMPTS_NAME, ASSOCIATION_PROPERTIES_NAME, ASSOCIATION_PROPERTYSETS_NAME, ASSOCIATION_REFERENCEDOBJECTS_NAME, ASSOCIATION_RESPONSIBLEPARTIES_NAME, ASSOCIATION_SOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECSOURCETRANSFORMATIONS_NAME, ASSOCIATION_SPECTARGETTRANSFORMATIONS_NAME, ASSOCIATION_TARGETTRANSFORMATIONS_NAME, ASSOCIATION_TIMESTAMPS_NAME, ASSOCIATION_TREES_NAME, ASSOCIATION_TSOBJECTNAMESPACE_NAME, ASSOCIATION_USEDBYPROTOTYPES_NAME, ASSOCIATION_USINGPROTOTYPE_NAME, ASSOCIATION_VARIABLES_NAME, ATTRIBUTE_CHANGESTATE_NAME, ATTRIBUTE_LOCKEDBY_NAME, ATTRIBUTE_USAGEVERSION_NAME

Fields inherited from interface com.sas.metadata.remote.MdObjectBase

ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME

Method Summary

java.lang.String	getActionType() Gets the String value of ActionType
int	getActionTypeMaxLength() Gets the maximum length of ActionType
int	getActionTypeState() Gets the Metadata State of ActionType
AssociationList	getConditionActionSets() Gets the Association list of ConditionActionSets
AssociationList	getConditionActionSets(boolean fGoToServer) Gets the Associationlist of ConditionActionSets
int	getInstanceVersion() Gets the int value of InstanceVersion
int	getInstanceVersionState() Gets the Metadata State of InstanceVersion
java.lang.String	getUniqueIdentifier() Gets the String value of UniqueIdentifier
int	getUniqueIdentifierMaxLength() Gets the maximum length of UniqueIdentifier
int	getUniqueIdentifierState() Gets the Metadata State of UniqueIdentifier
void	initializePredObjects() (S) Adds the Associated objects to the predObjects which are:
void	initializeRequiredObjects() (S) This initializes the Required Objects(Roles) which are:
void	setActionType(java.lang.String inActionType) Sets the ActionType value and sets the state to MetadataState.LOCAL.
void	setActionType(java.lang.String inActionType, int state) Sets the ActionType Metadata State.
void	setActionTypeState(int state) Sets the Metadata State of ActionType.
void	setConditionActionSets(AssociationList list) Sets the ConditionActionSets list to be list.
void	setConditionActionSets(AssociationList inObjects, int state) Sets the entire ConditionActionSets list to match the passed in AssociationList, sets the state of the ConditionActionSets
void	setInstanceVersion(int inInstanceVersion) Sets the InstanceVersion value and sets the state to MetadataState.LOCAL.
void	setInstanceVersion(int inInstanceVersion, int state) Sets the InstanceVersion Metadata State.
void	setInstanceVersion(java.lang.String inInstanceVersion) Sets the InstanceVersion value and sets the state to MetadataState.LOCAL.
void	setInstanceVersion(java.lang.String inInstanceVersion, int state) Sets the InstanceVersion value and Metadata State.
void	setInstanceVersionState(int state) Sets the Metadata State of InstanceVersion.
void	setUniqueIdentifier(java.lang.String inUniqueIdentifier) Sets the UniqueIdentifier value and sets the state to MetadataState.LOCAL.
void	setUniqueIdentifier(java.lang.String inUniqueIdentifier, int state) Sets the UniqueIdentifier Metadata State.
void	setUniqueIdentifierState(int state) Sets the Metadata State of UniqueIdentifier.

Methods inherited from interface com.sas.metadata.remote.PrimaryType

getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState

Methods inherited from interface com.sas.metadata.remote.Root

getAccessControls, getAccessControls, getChanges, getChanges, getChangeState, getChangeStateMaxLength, getChangeStateState, getCustomAssociations, getCustomAssociations, getDocuments, getDocuments, getExtensions, getExtensions, getExternalIdentities, getExternalIdentities, getGroups, getGroups, getImplementors, getImplementors, getKeywords, getKeywords, getLocalizedAttributes, getLocalizedAttributes, getLockedBy, getLockedByMaxLength, getLockedByState, getNotes, getNotes, getPrimaryPropertyGroup, getPrimaryPropertyGroups, getPrimaryPropertyGroups, getPrompts, getPrompts, getProperties, getProperties, getPropertySets, getPropertySets, getReferencedObjects, getReferencedObjects, getResponsibleParties, getResponsibleParties, getSourceTransformations, getSourceTransformations, getSpecSourceTransformations, getSpecSourceTransformations, getSpecTargetTransformations, getSpecTargetTransformations, getTargetTransformations, getTargetTransformations, getTimestamps, getTimestamps, getTrees, getTrees, getTSObjectNamespace, getTSObjectNamespaces, getTSObjectNamespaces, getUsageVersion, getUsageVersionState, getUsedByPrototypes, getUsedByPrototypes, getUsingPrototype, getUsingPrototypes, getUsingPrototypes, getVariables, getVariables, setAccessControls, setAccessControls, setChanges, setChanges, setChangeState, setChangeState, setChangeStateState, setCustomAssociations, setCustomAssociations, setDocuments, setDocuments, setExtensions, setExtensions, setExternalIdentities, setExternalIdentities, setGroups, setGroups, setImplementors, setImplementors, setKeywords, setKeywords, setLocalizedAttributes, setLocalizedAttributes, setLockedBy, setLockedBy, setLockedByState, setNotes, setNotes, setPrimaryPropertyGroup, setPrimaryPropertyGroups, setPrimaryPropertyGroups, setPrompts, setPrompts, setProperties, setProperties, setPropertySets, setPropertySets, setReferencedObjects, setReferencedObjects, setResponsibleParties, setResponsibleParties, setSourceTransformations, setSourceTransformations, setSpecSourceTransformations, setSpecSourceTransformations, setSpecTargetTransformations, setSpecTargetTransformations, setTargetTransformations, setTargetTransformations, setTimestamps, setTimestamps, setTrees, setTrees, setTSObjectNamespace, setTSObjectNamespaces, setTSObjectNamespaces, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersion, setUsageVersionState, setUsedByPrototypes, setUsedByPrototypes, setUsingPrototype, setUsingPrototypes, setUsingPrototypes, setVariables, setVariables

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML

closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll

Methods inherited from interface com.sas.metadata.remote.MdObjectBaseUtil

addMdObjectListener, delete, dispose, fireMdObjectModified, getAssociatedObjects, getAssociatedObjects, getAssociatedObjects, getAssociationNames, getAssocs, getAssocsWA, getAttributeNames, getAttrs, getAttrsStates, getChangeManagementState, getChgMgtExternalIdentityImportType, getClientSideOnlyObject, getMdObjectAssociation, getPopulatedAssocs, getUpdatedAttrs, getViewList, isCheckedOut, isLocked, objectModified, removeMdObjectListener, setAttrs, setChangeManagementTargetRepository, setChgMgtExternalIdentityImportType, setClientSideOnlyObject, setMdObjectAssociation, touch, updateAssnsIds

Methods inherited from interface com.sas.metadata.remote.MdObjectBase

addElementToChangeList, clearChangeList, getChangeList, getCMetadataType, getDesc, getDescMaxLength, getDescState, getFQID, getId, getIdState, getMetadataCreated, getMetadataCreatedState, getMetadataUpdated, getMetadataUpdatedState, getName, getNameMaxLength, getNameState, getObjectStore, getPredAssociations, getRepositoryID, getRequiredAssociations, getState, isAssociationRequired, isNewObject, isPredAssociation, removeElementFromChangeList, resetObject, resetState, resetStates, setCMetadataType, setDesc, setDesc, setDescState, setFQID, setFQID, setId, setId, setIdState, setMetadataCreated, setMetadataCreated, setMetadataCreatedState, setMetadataUpdated, setMetadataUpdated, setMetadataUpdatedState, setName, setName, setNameState, setObjectStore, setState

Field Detail

ATTRIBUTE_UNIQUEIDENTIFIER_NAME

static final java.lang.String ATTRIBUTE_UNIQUEIDENTIFIER_NAME

Constant used for the name of the UniqueIdentifier attribute.

UniqueIdentifier: The unique identifier for this action.

See Also:

Constant Field Values

ATTRIBUTE_ACTIONTYPE_NAME

static final java.lang.String ATTRIBUTE_ACTIONTYPE_NAME

Constant used for the name of the ActionType attribute.

ActionType: The type for this action.

See Also:

Constant Field Values

ATTRIBUTE_INSTANCEVERSION_NAME

static final java.lang.String ATTRIBUTE_INSTANCEVERSION_NAME

Constant used for the name of the InstanceVersion attribute.

InstanceVersion: Instance version counter - incremented whenever an update is made to the design time objects. If the instance version of the run time object does not match the design time object it is based on, the run time instance will be updated to match the design time instance.

See Also:

Constant Field Values

ASSOCIATION_CONDITIONACTIONSETS_NAME

static final java.lang.String ASSOCIATION_CONDITIONACTIONSETS_NAME

Constant used for the name of the ConditionActionSets association.

ConditionActionSets: The condition action sets of that this action is a part.

See Also:

Constant Field Values

Method Detail

initializeRequiredObjects

void initializeRequiredObjects()
                               throws java.rmi.RemoteException

(S) This initializes the Required Objects(Roles) which are:

Specified by:

initializeRequiredObjects in interface MdObjectBaseUtil

Specified by:

initializeRequiredObjects in interface PrimaryType

Specified by:

initializeRequiredObjects in interface Root

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

initializePredObjects

void initializePredObjects()
                           throws java.rmi.RemoteException

(S) Adds the Associated objects to the predObjects which are:

Specified by:

initializePredObjects in interface MdObjectBase

Specified by:

initializePredObjects in interface PrimaryType

Specified by:

initializePredObjects in interface Root

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getUniqueIdentifier

java.lang.String getUniqueIdentifier()
                                     throws java.rmi.RemoteException

Gets the String value of UniqueIdentifier

Returns:

The UniqueIdentifier

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getUniqueIdentifierState

int getUniqueIdentifierState()
                             throws java.rmi.RemoteException

Gets the Metadata State of UniqueIdentifier

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getUniqueIdentifierMaxLength

int getUniqueIdentifierMaxLength()
                                 throws java.rmi.RemoteException

Gets the maximum length of UniqueIdentifier

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getActionType

java.lang.String getActionType()
                               throws java.rmi.RemoteException

Gets the String value of ActionType

Returns:

The ActionType

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getActionTypeState

int getActionTypeState()
                       throws java.rmi.RemoteException

Gets the Metadata State of ActionType

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getActionTypeMaxLength

int getActionTypeMaxLength()
                           throws java.rmi.RemoteException

Gets the maximum length of ActionType

Returns:

The max size

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getInstanceVersion

int getInstanceVersion()
                       throws java.rmi.RemoteException

Gets the int value of InstanceVersion

Returns:

The InstanceVersion

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getInstanceVersionState

int getInstanceVersionState()
                            throws java.rmi.RemoteException

Gets the Metadata State of InstanceVersion

Returns:

The State.

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

getConditionActionSets

AssociationList getConditionActionSets()
                                       throws java.rmi.RemoteException,
                                              MdException

Gets the Association list of ConditionActionSets

Returns:

The AssociationList of ConditionActionSets which can be of type:
ConditionActionSet

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

getConditionActionSets

AssociationList getConditionActionSets(boolean fGoToServer)
                                       throws java.rmi.RemoteException,
                                              MdException

Gets the Associationlist of ConditionActionSets

Parameters:

fGoToServer - boolean Get the value from the server.

Returns:

Returns the ConditionActionSets which can be of type:
ConditionActionSet

Throws:

java.rmi.RemoteException - If error connecting/communicating to/with remote object.

MdException - If error getting/setting part of the object.

setUniqueIdentifier

void setUniqueIdentifier(java.lang.String inUniqueIdentifier)
                         throws java.rmi.RemoteException

Sets the UniqueIdentifier value and sets the state to MetadataState.LOCAL.

Parameters:

inUniqueIdentifier - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setUniqueIdentifier

void setUniqueIdentifier(java.lang.String inUniqueIdentifier,
                         int state)
                         throws java.rmi.RemoteException

Sets the UniqueIdentifier Metadata State.

Parameters:

inUniqueIdentifier - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setUniqueIdentifierState

void setUniqueIdentifierState(int state)
                              throws java.rmi.RemoteException

Sets the Metadata State of UniqueIdentifier.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setActionType

void setActionType(java.lang.String inActionType)
                   throws java.rmi.RemoteException

Sets the ActionType value and sets the state to MetadataState.LOCAL.

Parameters:

inActionType - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setActionType

void setActionType(java.lang.String inActionType,
                   int state)
                   throws java.rmi.RemoteException

Sets the ActionType Metadata State.

Parameters:

inActionType - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setActionTypeState

void setActionTypeState(int state)
                        throws java.rmi.RemoteException

Sets the Metadata State of ActionType.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setInstanceVersion

void setInstanceVersion(int inInstanceVersion)
                        throws java.rmi.RemoteException

Sets the InstanceVersion value and sets the state to MetadataState.LOCAL.

Parameters:

inInstanceVersion - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setInstanceVersion

void setInstanceVersion(int inInstanceVersion,
                        int state)
                        throws java.rmi.RemoteException

Sets the InstanceVersion Metadata State.

Parameters:

inInstanceVersion - int

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setInstanceVersion

void setInstanceVersion(java.lang.String inInstanceVersion)
                        throws java.rmi.RemoteException

Sets the InstanceVersion value and sets the state to MetadataState.LOCAL.

Parameters:

inInstanceVersion - String

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setInstanceVersion

void setInstanceVersion(java.lang.String inInstanceVersion,
                        int state)
                        throws java.rmi.RemoteException

Sets the InstanceVersion value and Metadata State.

Parameters:

inInstanceVersion - String

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setInstanceVersionState

void setInstanceVersionState(int state)
                             throws java.rmi.RemoteException

Sets the Metadata State of InstanceVersion.

Parameters:

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setConditionActionSets

void setConditionActionSets(AssociationList list)
                            throws java.rmi.RemoteException

Sets the ConditionActionSets list to be list. Objects of which can be of type:
ConditionActionSet

Parameters:

list - AssociationList

Throws:

java.rmi.RemoteException - If error communicating with remote object.

setConditionActionSets

void setConditionActionSets(AssociationList inObjects,
                            int state)
                            throws java.rmi.RemoteException

Sets the entire ConditionActionSets list to match the passed in AssociationList, sets the state of the ConditionActionSets

Parameters:

inObjects - AssociationList

state - int

Throws:

java.rmi.RemoteException - If error communicating with remote object.