Package com.sas.metadata.remote

Interface ExternalIdentity

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface ExternalIdentity extends SecondaryType
This is an ID associated with the object in some other context, such as a GUID or DN for LDAP .

Attributes of ExternalIdentity are:

Associations of ExternalIdentity are:

Usage

To create an instance of this ExternalIdentity, use the factory create methods.
Example: create a ExternalIdentity with name "ExternalIdentity_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();
 ExternalIdentity myObject = (ExternalIdentity) factory.createComplexMetadataObject(objectStore, "ExternalIdentity_Object", MetadataObjects.EXTERNALIDENTITY, "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: The context for this ID, such as GUID, LDAP DN, or OM repository ID.

      See Also:

    • ATTRIBUTE_IDENTIFIER_NAME

      static final String ATTRIBUTE_IDENTIFIER_NAME
      Constant used for the name of the Identifier attribute.

      Identifier: The identifier in the originating context.

      See Also:

    • ATTRIBUTE_IMPORTTYPE_NAME

      static final String ATTRIBUTE_IMPORTTYPE_NAME
      Constant used for the name of the ImportType attribute.

      ImportType: How the owning object was created. such as Copy, Import

      See Also:

    • ASSOCIATION_OWNINGOBJECT_NAME

      static final String ASSOCIATION_OWNINGOBJECT_NAME
      Constant used for the name of the OwningObject association.

      OwningObject: The object that had this ID in another context.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningObject
      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:
      OwningObject
      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.

    • getIdentifier

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

    • getIdentifierState

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

    • getIdentifierMaxLength

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

    • getImportType

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

    • getImportTypeState

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

    • getImportTypeMaxLength

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

    • getOwningObjects

      AssociationList getOwningObjects() throws RemoteException, MdException
      Gets the AssociationList of OwningObjects
      Returns:
      Returns the AssociationList of OwningObjects which can be of type:
      All types
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getOwningObject

      Root getOwningObject() throws RemoteException, MdException
      Gets the Root for OwningObject
      Returns:
      The Root ( null if not set) of OwningObjectwhich can be of type:
      All types
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningObjects

      AssociationList getOwningObjects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of OwningObjects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of OwningObjects which can be of type:
      All types
      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.

    • setIdentifier

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

    • setIdentifier

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

    • setIdentifierState

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

    • setImportType

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

    • setImportType

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

    • setImportTypeState

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

    • setOwningObjects

      void setOwningObjects(AssociationList list) throws RemoteException
      Sets the OwningObjects list to be list. Object of which can be of type:
      All types
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningObjects

      void setOwningObjects(AssociationList list, int state) throws RemoteException
      Sets the OwningObjects list to be list. Object of which can be of type:
      All types
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningObject

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