Package com.sas.metadata.remote

Interface Directory

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
AnalyticContext
public interface Directory extends ContentLocation
Represents a physical operating system path. Directory objects should not be shared by logical metadata definitions. Each logical metadata definition should define its own Directory object.

Attributes of Directory are:

Associations of Directory are:

Usage

To create an instance of this Directory, use the factory create methods.
Example: create a Directory with name "Directory_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();
 Directory myObject = (Directory) factory.createComplexMetadataObject(objectStore, "Directory_Object", MetadataObjects.DIRECTORY, "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_DIRECTORYNAME_NAME

      static final String ATTRIBUTE_DIRECTORYNAME_NAME
      Constant used for the name of the DirectoryName attribute.

      DirectoryName: The name of this directory in the file system.

      See Also:

    • ATTRIBUTE_ISRELATIVE_NAME

      static final String ATTRIBUTE_ISRELATIVE_NAME
      Constant used for the name of the IsRelative attribute.

      IsRelative: True if the DirectoryName is not a fully qualified path.

      See Also:

    • ATTRIBUTE_DIRECTORYROLE_NAME

      static final String ATTRIBUTE_DIRECTORYROLE_NAME
      Constant used for the name of the DirectoryRole attribute.

      DirectoryRole: Directory role is used when a directory should be used only within a given context.

      See Also:

    • ASSOCIATION_FILES_NAME

      static final String ASSOCIATION_FILES_NAME
      Constant used for the name of the Files association.

      Files: The files in this directory.  

      See Also:

    • ASSOCIATION_PARENT_NAME

      static final String ASSOCIATION_PARENT_NAME
      Constant used for the name of the Parent association.

      Parent: The parent directory of this directory.  

      See Also:

    • ASSOCIATION_DIMENSIONS_NAME

      static final String ASSOCIATION_DIMENSIONS_NAME
      Constant used for the name of the Dimensions association.

      Dimensions: The shared dimensions in this directory. 

      See Also:

    • ASSOCIATION_ITCHANNELS_NAME

      static final String ASSOCIATION_ITCHANNELS_NAME
      Constant used for the name of the ITChannels association.

      ITChannels: The ITChannels that publish to this location. 

      See Also:

    • ASSOCIATION_ITSUBSCRIBERS_NAME

      static final String ASSOCIATION_ITSUBSCRIBERS_NAME
      Constant used for the name of the ITSubscribers association.

      ITSubscribers: The ITSsubscribers for this http server directory. 

      See Also:

    • ASSOCIATION_PATHCHANNELS_NAME

      static final String ASSOCIATION_PATHCHANNELS_NAME
      Constant used for the name of the PathChannels association.

      PathChannels: The channels that have defined this directory as a preferred archive directory. 

      See Also:

    • ASSOCIATION_SUBDIRECTORIES_NAME

      static final String ASSOCIATION_SUBDIRECTORIES_NAME
      Constant used for the name of the SubDirectories association.

      SubDirectories: The subdirectories of this directory. 

      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
      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:
      Files
      Parent
      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
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getDirectoryName

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

    • getDirectoryNameState

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

    • getDirectoryNameMaxLength

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

    • getIsRelative

      int getIsRelative() throws RemoteException
      Gets the int value of IsRelative
      Returns:
      The IsRelative
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsRelativeState

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

    • getDirectoryRole

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

    • getDirectoryRoleState

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

    • getDirectoryRoleMaxLength

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

    • getFiles

      AssociationList getFiles() throws RemoteException, MdException
      Gets the AssociationList of Files
      Returns:
      Returns the AssociationList of Files which can be of type:
      File
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getParents

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

    • getParent

      Directory getParent() throws RemoteException, MdException
      Gets the Directory for Parent
      Returns:
      The Directory ( null if not set) of Parentwhich can be of type:
      Directory
      AnalyticContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getDimensions

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

    • getITChannels

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

    • getITSubscribers

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

    • getPathChannels

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

    • getSubDirectories

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

    • getFiles

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

    • getParents

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

    • getDimensions

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

    • getITChannels

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

    • getITSubscribers

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

    • getPathChannels

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

    • getSubDirectories

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

    • setDirectoryName

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

    • setDirectoryName

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

    • setDirectoryNameState

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

    • setIsRelative

      void setIsRelative(int inIsRelative) throws RemoteException
      Sets the IsRelative value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsRelative - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsRelative

      void setIsRelative(int inIsRelative, int state) throws RemoteException
      Sets the IsRelative Metadata State.
      Parameters:
      inIsRelative - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsRelative

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

    • setIsRelative

      void setIsRelative(String inIsRelative, int state) throws RemoteException
      Sets the IsRelative value and Metadata State.
      Parameters:
      inIsRelative - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsRelativeState

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

    • setDirectoryRole

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

    • setDirectoryRole

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

    • setDirectoryRoleState

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

    • setFiles

      void setFiles(AssociationList list) throws RemoteException
      Sets the Files list to be list. Objects of which can be of type:
      File
      ArchiveFile
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setFiles

      void setFiles(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.

    • setParents

      void setParents(AssociationList list) throws RemoteException
      Sets the Parents list to be list. Object of which can be of type:
      Directory
      AnalyticContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setParents

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

    • setParent

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

    • setDimensions

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

    • setDimensions

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

    • setITChannels

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

    • setITChannels

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

    • setITSubscribers

      void setITSubscribers(AssociationList list) throws RemoteException
      Sets the ITSubscribers list to be list. Objects of which can be of type:
      ITSubscriber
      ITContentSubscriber
      ITEventSubscriber
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setITSubscribers

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

    • setPathChannels

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

    • setPathChannels

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

    • setSubDirectories

      void setSubDirectories(AssociationList list) throws RemoteException
      Sets the SubDirectories list to be list. Objects of which can be of type:
      Directory
      AnalyticContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubDirectories

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