Package com.sas.metadata.remote

Interface Role

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface Role extends SecondaryType
This object describes a role of of an object, and the context of the role.

Defined contexts are:

  • ContentType
  • WA (abbreviation for SAS Data Integration Studio)
  • EM (abbreviation for SAS Enterprise Miner)

  • For ContentType, valid roles are BASE, NWAY, AGGREGATE, STARFACT, STARTDIM
  • For WA, valid roles are Source, Target
  • For EM, valid roles are Training

The list of roles will be expanded, along with the list of contexts.

Attributes of Role are:

Associations of Role are:

Usage

To create an instance of this Role, use the factory create methods.
Example: create a Role with name "Role_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();
 Role myObject = (Role) factory.createComplexMetadataObject(objectStore, "Role_Object", MetadataObjects.ROLE, "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_CONTEXT_NAME

      static final String ATTRIBUTE_CONTEXT_NAME
      Constant used for the name of the Context attribute.

      Context: This is the context or category of the role. Valid values include EM, WA and ContentType.

      See Also:

    • ATTRIBUTE_OBJECTROLE_NAME

      static final String ATTRIBUTE_OBJECTROLE_NAME
      Constant used for the name of the ObjectRole attribute.

      ObjectRole: This attribute describes the role in a particular context. For example, if the context is ContentType, the ObjectRole can be Summary or Base. If the context is WA, the ObjectRole can be Source or Target.

      See Also:

    • ASSOCIATION_ROLEOBJECT_NAME

      static final String ASSOCIATION_ROLEOBJECT_NAME
      Constant used for the name of the RoleObject association.

      RoleObject: The object that is playing this particular role.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      RoleObject
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      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:
      RoleObject
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getContext

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

    • getContextState

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

    • getContextMaxLength

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

    • getObjectRole

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

    • getObjectRoleState

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

    • getObjectRoleMaxLength

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

    • getRoleObjects

      AssociationList getRoleObjects() throws RemoteException, MdException
      Gets the AssociationList of RoleObjects
      Returns:
      Returns the AssociationList of RoleObjects which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getRoleObject

      DataTable getRoleObject() throws RemoteException, MdException
      Gets the DataTable for RoleObject
      Returns:
      The DataTable ( null if not set) of RoleObjectwhich can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getRoleObjects

      AssociationList getRoleObjects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of RoleObjects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of RoleObjects which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setContext

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

    • setContext

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

    • setContextState

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

    • setObjectRole

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

    • setObjectRole

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

    • setObjectRoleState

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

    • setRoleObjects

      void setRoleObjects(AssociationList list) throws RemoteException
      Sets the RoleObjects list to be list. Object of which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setRoleObjects

      void setRoleObjects(AssociationList list, int state) throws RemoteException
      Sets the RoleObjects list to be list. Object of which can be of type:
      DataTable
      ExternalTable
      RelationalTable
      PhysicalTable
      WorkTable
      SecuredTable
      QueryTable
      JoinTable
      TableCollection
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setRoleObject

      void setRoleObject(DataTable inObject) throws RemoteException
      Sets the RoleObjects list 0th element to be inObject.
      Parameters:
      inObject - DataTable
      Throws:
      RemoteException - If error communicating with remote object.