Package com.sas.metadata.remote

Interface ApplicationAction

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface ApplicationAction extends PrimaryType
Represents a feature/action of an application. These are used in conjunction with Roles (IdentityGroup objects with a type of Role) to control which application features are made available to different users. Application actions are designed by applications and created by them during installation and/or configuration. The user manager can be used to create roles and manage user access to those features. Since applications are designed to respond only to certain actions there is no need for users to explicitly create their own application actions.

Attributes of ApplicationAction are:

Associations of ApplicationAction are:

Usage

To create an instance of this ApplicationAction, use the factory create methods.
Example: create a ApplicationAction with name "ApplicationAction_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();
 ApplicationAction myObject = (ApplicationAction) factory.createComplexMetadataObject(objectStore, "ApplicationAction_Object", MetadataObjects.APPLICATIONACTION, "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_ACTIONIDENTIFIER_NAME

      static final String ATTRIBUTE_ACTIONIDENTIFIER_NAME
      Constant used for the name of the ActionIdentifier attribute.

      ActionIdentifier: ActionIdentifier

      See Also:

    • ATTRIBUTE_ACTIONTYPE_NAME

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

      ActionType: ActionType

      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.

    • getActionIdentifier

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

    • getActionIdentifierState

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

    • getActionIdentifierMaxLength

      int getActionIdentifierMaxLength() throws RemoteException
      Gets the maximum length of ActionIdentifier
      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.

    • setActionIdentifier

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

    • setActionIdentifier

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

    • setActionIdentifierState

      void setActionIdentifierState(int state) throws RemoteException
      Sets the Metadata State of ActionIdentifier.
      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.