Package com.sas.metadata.remote

Interface SASFileRef

All Superinterfaces:
CMetadata, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface SASFileRef extends DeployedDataPackage
Represents a name temporarily assigned to an external file or to an aggregate storage location that identifies it to SAS. The associated ContentLocations (and this should be a single object except for concatenated files) represent the location used by the fileref.

Attributes of SASFileRef are:

Associations of SASFileRef are:

Usage

To create an instance of this SASFileRef, use the factory create methods.
Example: create a SASFileRef with name "SASFileRef_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();
 SASFileRef myObject = (SASFileRef) factory.createComplexMetadataObject(objectStore, "SASFileRef_Object", MetadataObjects.SASFILEREF, "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_FILEREF_NAME

      static final String ATTRIBUTE_FILEREF_NAME
      Constant used for the name of the Fileref attribute.

      Fileref: The fileref used by SAS software.

      See Also:

    • ATTRIBUTE_ACCESSMETHOD_NAME

      static final String ATTRIBUTE_ACCESSMETHOD_NAME
      Constant used for the name of the AccessMethod attribute.

      AccessMethod: The access method SAS software uses to access the file.

      See Also:

    • ATTRIBUTE_ISPREASSIGNED_NAME

      static final String ATTRIBUTE_ISPREASSIGNED_NAME
      Constant used for the name of the IsPreassigned attribute.

      IsPreassigned: If true, the other attributes of this object that contain information used by a FILENAME statement may be provided for documentation purposes only but is not required to access the file, because it has been assigned via some other mechanism.

      See Also:

    • ASSOCIATION_FILEREFLOCATIONS_NAME

      static final String ASSOCIATION_FILEREFLOCATIONS_NAME
      Constant used for the name of the FileRefLocations association.

      FileRefLocations: The location used by this fileref. This should be at most a single object except for concatenated files.  

      See Also:

    • ASSOCIATION_REPORTS_NAME

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

      Reports: The reports that use this fileref for location.  

      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:
      FileRefLocations
      Reports
      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.

    • getFileref

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

    • getFilerefState

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

    • getFilerefMaxLength

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

    • getAccessMethod

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

    • getAccessMethodState

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

    • getAccessMethodMaxLength

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

    • getIsPreassigned

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

    • getIsPreassignedState

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

    • getFileRefLocations

      AssociationList getFileRefLocations() throws RemoteException, MdException
      Gets the AssociationList of FileRefLocations
      Returns:
      Returns the AssociationList of FileRefLocations which can be of type:
      ContentLocation
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Directory
      AnalyticContext
      Device
      Stream
      Memory
      Connection
      SASClientConnection
      OpenClientConnection
      TCPIPConnection
      COMConnection
      Email
      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 AssociationList of Reports
      Returns:
      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.

    • getFileRefLocations

      AssociationList getFileRefLocations(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of FileRefLocations
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of FileRefLocations which can be of type:
      ContentLocation
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Directory
      AnalyticContext
      Device
      Stream
      Memory
      Connection
      SASClientConnection
      OpenClientConnection
      TCPIPConnection
      COMConnection
      Email
      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 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.

    • setFileref

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

    • setFileref

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

    • setFilerefState

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

    • setAccessMethod

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

    • setAccessMethod

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

    • setAccessMethodState

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

    • setIsPreassigned

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

    • setIsPreassigned

      void setIsPreassigned(int inIsPreassigned, int state) throws RemoteException
      Sets the IsPreassigned Metadata State.
      Parameters:
      inIsPreassigned - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsPreassigned

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

    • setIsPreassigned

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

    • setIsPreassignedState

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

    • setFileRefLocations

      void setFileRefLocations(AssociationList list) throws RemoteException
      Sets the FileRefLocations list to be list. Objects of which can be of type:
      ContentLocation
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Directory
      AnalyticContext
      Device
      Stream
      Memory
      Connection
      SASClientConnection
      OpenClientConnection
      TCPIPConnection
      COMConnection
      Email
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setFileRefLocations

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

    • 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 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.