Package com.sas.metadata.remote

Interface Document

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, Text
public interface Document extends Text
A Document is a web page or other conent that contains documentation pertinent to the object to which this document is related.

Attributes of Document are:

Associations of Document are:

Usage

To create an instance of this Document, use the factory create methods.
Example: create a Document with name "Document_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();
 Document myObject = (Document) factory.createComplexMetadataObject(objectStore, "Document_Object", MetadataObjects.DOCUMENT, "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_URI_NAME

      static final String ATTRIBUTE_URI_NAME
      Constant used for the name of the URI attribute.

      URI: This is the URI through which this document can be accessed.

      See Also:

    • ATTRIBUTE_URITYPE_NAME

      static final String ATTRIBUTE_URITYPE_NAME
      Constant used for the name of the URIType attribute.

      URIType: This is the type of URI, such as File, URL, Publication, etc.

      See Also:

    • ASSOCIATION_OBJECTS_NAME

      static final String ASSOCIATION_OBJECTS_NAME
      Constant used for the name of the Objects association.

      Objects: The objects that are associated with this document.  

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getURI

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

    • getURIState

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

    • getURIMaxLength

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

    • getURIType

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

    • getURITypeState

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

    • getURITypeMaxLength

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

    • getObjects

      AssociationList getObjects() throws RemoteException, MdException
      Gets the AssociationList of Objects
      Returns:
      Returns the AssociationList of Objects 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.

    • getObjects

      AssociationList getObjects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Objects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of Objects 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.

    • setURI

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

    • setURI

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

    • setURIState

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

    • setURIType

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

    • setURIType

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

    • setURITypeState

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

    • setObjects

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

    • setObjects

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