Interface LocalizedType

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
All Known Subinterfaces:
AbstractProperty, AssociationProperty, AttributeProperty, Property, PropertyGroup, PropertyType, PrototypeProperty

public interface LocalizedType extends SecondaryType
This is the abstract supertype for all of the types that have localized resources.

Attributes of LocalizedType are:

Associations of LocalizedType are:

Usage

To create an instance of this LocalizedType, use the factory create methods.
Example: create a LocalizedType with name "LocalizedType_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();
 LocalizedType myObject = (LocalizedType) factory.createComplexMetadataObject(objectStore, "LocalizedType_Object", MetadataObjects.LOCALIZEDTYPE, "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_RESOURCES_NAME

      static final String ASSOCIATION_RESOURCES_NAME
      Constant used for the name of the Resources association.

      Resources: Resources are the objects that contain localized strings or a location from which to obtain localized information.  

      See Also:
  • Method Details

    • initializeRequiredObjects

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

      AssociationList getResources() throws RemoteException, MdException
      Gets the AssociationList of Resources
      Returns:
      Returns the AssociationList of Resources which can be of type:
      LocalizedResource
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.
    • getResources

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

      void setResources(AssociationList list) throws RemoteException
      Sets the Resources list to be list. Objects of which can be of type:
      LocalizedResource
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.
    • setResources

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