Package com.sas.metadata.remote

Interface Action

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Action extends PrimaryType
An action that will be performed when a stated condition is met.

Attributes of Action are:

Associations of Action are:

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 Details

    • ATTRIBUTE_UNIQUEIDENTIFIER_NAME

      static final String ATTRIBUTE_UNIQUEIDENTIFIER_NAME
      Constant used for the name of the UniqueIdentifier attribute.

      UniqueIdentifier: The unique identifier for this action.

      See Also:

    • ATTRIBUTE_ACTIONTYPE_NAME

      static final String ATTRIBUTE_ACTIONTYPE_NAME
      Constant used for the name of the ActionType attribute.

      ActionType: The type for this action.

      See Also:

    • ATTRIBUTE_INSTANCEVERSION_NAME

      static final 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:

    • ASSOCIATION_CONDITIONACTIONSETS_NAME

      static final 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:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws 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:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws 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:
      RemoteException - If error connecting/communicating to/with remote object.

    • getUniqueIdentifier

      String getUniqueIdentifier() throws RemoteException
      Gets the String value of UniqueIdentifier
      Returns:
      The UniqueIdentifier
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getUniqueIdentifierState

      int getUniqueIdentifierState() throws RemoteException
      Gets the Metadata State of UniqueIdentifier
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getUniqueIdentifierMaxLength

      int getUniqueIdentifierMaxLength() throws RemoteException
      Gets the maximum length of UniqueIdentifier
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getActionType

      String getActionType() throws RemoteException
      Gets the String value of ActionType
      Returns:
      The ActionType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getActionTypeState

      int getActionTypeState() throws RemoteException
      Gets the Metadata State of ActionType
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getActionTypeMaxLength

      int getActionTypeMaxLength() throws RemoteException
      Gets the maximum length of ActionType
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getInstanceVersion

      int getInstanceVersion() throws RemoteException
      Gets the int value of InstanceVersion
      Returns:
      The InstanceVersion
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getInstanceVersionState

      int getInstanceVersionState() throws RemoteException
      Gets the Metadata State of InstanceVersion
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getConditionActionSets

      AssociationList getConditionActionSets() throws RemoteException, MdException
      Gets the Association list of ConditionActionSets
      Returns:
      The AssociationList of ConditionActionSets which can be of type:
      ConditionActionSet
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getConditionActionSets

      AssociationList getConditionActionSets(boolean fGoToServer) throws 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:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setUniqueIdentifier

      void setUniqueIdentifier(String inUniqueIdentifier) throws RemoteException
      Sets the UniqueIdentifier value and sets the state to MetadataState.LOCAL.
      Parameters:
      inUniqueIdentifier - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setUniqueIdentifier

      void setUniqueIdentifier(String inUniqueIdentifier, int state) throws RemoteException
      Sets the UniqueIdentifier Metadata State.
      Parameters:
      inUniqueIdentifier - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setUniqueIdentifierState

      void setUniqueIdentifierState(int state) throws RemoteException
      Sets the Metadata State of UniqueIdentifier.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setActionType

      void setActionType(String inActionType) throws RemoteException
      Sets the ActionType value and sets the state to MetadataState.LOCAL.
      Parameters:
      inActionType - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setActionType

      void setActionType(String inActionType, int state) throws RemoteException
      Sets the ActionType Metadata State.
      Parameters:
      inActionType - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setActionTypeState

      void setActionTypeState(int state) throws RemoteException
      Sets the Metadata State of ActionType.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setInstanceVersion

      void setInstanceVersion(int inInstanceVersion) throws RemoteException
      Sets the InstanceVersion value and sets the state to MetadataState.LOCAL.
      Parameters:
      inInstanceVersion - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setInstanceVersion

      void setInstanceVersion(int inInstanceVersion, int state) throws RemoteException
      Sets the InstanceVersion Metadata State.
      Parameters:
      inInstanceVersion - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setInstanceVersion

      void setInstanceVersion(String inInstanceVersion) throws RemoteException
      Sets the InstanceVersion value and sets the state to MetadataState.LOCAL.
      Parameters:
      inInstanceVersion - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setInstanceVersion

      void setInstanceVersion(String inInstanceVersion, int state) throws RemoteException
      Sets the InstanceVersion value and Metadata State.
      Parameters:
      inInstanceVersion - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setInstanceVersionState

      void setInstanceVersionState(int state) throws RemoteException
      Sets the Metadata State of InstanceVersion.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setConditionActionSets

      void setConditionActionSets(AssociationList list) throws RemoteException
      Sets the ConditionActionSets list to be list. Objects of which can be of type:
      ConditionActionSet
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setConditionActionSets

      void setConditionActionSets(AssociationList inObjects, int state) throws RemoteException
      Sets the entire ConditionActionSets list to match the passed in AssociationList, sets the state of the ConditionActionSets
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.