Package com.sas.metadata.remote

Interface ContentLocation

All Superinterfaces:
CMetadata, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
AnalyticContext, ArchiveEntry, ArchiveFile, COMConnection, Connection, Device, Directory, Document, Email, File, Memory, OpenClientConnection, SASCatalogEntry, SASClientConnection, Stream, TCPIPConnection, Text, TextStore
public interface ContentLocation extends DeployedDataPackage
The supertype for all types that provide location information.

Attributes of ContentLocation are:

Associations of ContentLocation are:

Usage

To create an instance of this ContentLocation, use the factory create methods.
Example: create a ContentLocation with name "ContentLocation_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();
 ContentLocation myObject = (ContentLocation) factory.createComplexMetadataObject(objectStore, "ContentLocation_Object", MetadataObjects.CONTENTLOCATION, "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

    • ASSOCIATION_ASSOCIATEDCONTENTTYPE_NAME

      static final String ASSOCIATION_ASSOCIATEDCONTENTTYPE_NAME
      Constant used for the name of the AssociatedContentType association.

      AssociatedContentType: A description of the content.  

      See Also:

    • ASSOCIATION_FILEREFS_NAME

      static final String ASSOCIATION_FILEREFS_NAME
      Constant used for the name of the FileRefs association.

      FileRefs: The filerefs that use this ContentLocation. 

      See Also:

    • ASSOCIATION_REPORTS_NAME

      static final String ASSOCIATION_REPORTS_NAME
      Constant used for the name of the Reports association.

      Reports: The reports that are stored or transmitted using this ContentLocation. 

      See Also:

    • ASSOCIATION_TSASSOCIATEDNAMESPACE_NAME

      static final String ASSOCIATION_TSASSOCIATEDNAMESPACE_NAME
      Constant used for the name of the TSAssociatedNamespace association.

      TSAssociatedNamespace: The associated table server namespace. 

      See Also:

    • ASSOCIATION_UNITOFTIMES_NAME

      static final String ASSOCIATION_UNITOFTIMES_NAME
      Constant used for the name of the UnitofTimes association.

      UnitofTimes: The UnitofTime objects associated with this content. This may represent refresh times for the content. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface DeployedDataPackage
      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:
      AssociatedContentType
      Specified by:
      initializePredObjects in interface DeployedDataPackage
      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.

    • getAssociatedContentTypes

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

    • getAssociatedContentType

      ContentType getAssociatedContentType() throws RemoteException, MdException
      Gets the ContentType for AssociatedContentType
      Returns:
      The ContentType ( null if not set) of AssociatedContentTypewhich can be of type:
      ContentType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getFileRefs

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

    • getReports

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

    • getTSAssociatedNamespaces

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

    • getTSAssociatedNamespace

      TSNamespace getTSAssociatedNamespace() throws RemoteException, MdException
      Gets the TSNamespace for TSAssociatedNamespace
      Returns:
      The TSNamespace ( null if not set ) of TSAssociatedNamespace which can be of type:
      TSNamespace
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getUnitofTimes

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

    • getAssociatedContentTypes

      AssociationList getAssociatedContentTypes(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of AssociatedContentTypes
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of AssociatedContentTypes which can be of type:
      ContentType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getFileRefs

      AssociationList getFileRefs(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of FileRefs
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the FileRefs which can be of type:
      SASFileRef
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getReports

      AssociationList getReports(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Reports
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the Reports which can be of type:
      Report
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTSAssociatedNamespaces

      AssociationList getTSAssociatedNamespaces(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TSAssociatedNamespaces
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the TSAssociatedNamespaces which can be of type:
      TSNamespace
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getUnitofTimes

      AssociationList getUnitofTimes(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of UnitofTimes
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the UnitofTimes which can be of type:
      UnitofTime
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setAssociatedContentTypes

      void setAssociatedContentTypes(AssociationList list) throws RemoteException
      Sets the AssociatedContentTypes list to be list. Object of which can be of type:
      ContentType
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedContentTypes

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

    • setAssociatedContentType

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

    • setFileRefs

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

    • setFileRefs

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

    • setReports

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

    • setReports

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

    • setTSAssociatedNamespaces

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

    • setTSAssociatedNamespaces

      void setTSAssociatedNamespaces(AssociationList list, int state) throws RemoteException
      Sets the TSAssociatedNamespaces list to be list. Objects of which can be of type:
      TSNamespace
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setTSAssociatedNamespace

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

    • setUnitofTimes

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

    • setUnitofTimes

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