Package com.sas.metadata.remote

Interface Device

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Device extends ContentLocation
Describes location information for SAS Filerefs.

Attributes of Device are:

Associations of Device are:

Usage

To create an instance of this Device, use the factory create methods.
Example: create a Device with name "Device_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();
 Device myObject = (Device) factory.createComplexMetadataObject(objectStore, "Device_Object", MetadataObjects.DEVICE, "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_DEVICENAME_NAME

      static final String ATTRIBUTE_DEVICENAME_NAME
      Constant used for the name of the DeviceName attribute.

      DeviceName: This attribute is used to describe location information for SAS Filerefs using the following engines; PIPE, PLOTTER, PRINTER, TAPE, TERMINAL and XPRINTER

      See Also:

    • ASSOCIATION_ASSOCIATEDDEVICETYPE_NAME

      static final String ASSOCIATION_ASSOCIATEDDEVICETYPE_NAME
      Constant used for the name of the AssociatedDeviceType association.

      AssociatedDeviceType: Description of the device. 

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

    • getDeviceName

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

    • getDeviceNameState

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

    • getDeviceNameMaxLength

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

    • getAssociatedDeviceTypes

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

    • getAssociatedDeviceType

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

    • getAssociatedDeviceTypes

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

    • setDeviceName

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

    • setDeviceName

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

    • setDeviceNameState

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

    • setAssociatedDeviceTypes

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

    • setAssociatedDeviceTypes

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

    • setAssociatedDeviceType

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