com.ibm.ram.client
Class RAMAssetType

java.lang.Object
  extended by com.ibm.ram.common.data.AssetType
      extended by com.ibm.ram.client.RAMAssetType

public class RAMAssetType
extends AssetType

Represents one asset type. Every asset has an AssetType, which classifies the asset.

Since:
7.1
Author:
kbauer

Method Summary
 RAMAttributeConstraint createAttributeConstraint(RAMAssetAttribute attribute, boolean required)
          Creates a new attribute constraint on an asset type.
 CommunityAssetType createCommunityAssetType(CommunityInformation community)
          Returns the list of Community scoped versions of this Asset Type.
 RAMAction getAction()
          Set the action to be performed on the session object.
 RAMAttributeConstraint[] getAttributeConstraints()
          Returns the list of attribute constraints set on this asset type
 CommunityAssetType getCommunityAssetType(CommunityInformation community)
          Returns the list of Community scoped versions of this Asset Type.
 CommunityAssetType[] getCommunityAssetTypes()
          Returns the list of Community scoped versions of this Asset Type
 java.lang.String getConfiguration()
          Get the configuration string, either null, or empty string, or a valid XMI file contents.
 java.lang.String getDescription()
           
 int getId()
          The internal id of the asset type within the repository.
 java.lang.String getName()
           
 java.lang.String getURI()
           
 boolean isDirty()
          Returns true if the Object has been modified from the copy on the server
 boolean isPrivate()
          TODO Should these be on the SO obejcts? (non-Javadoc)
 boolean isRestricted()
          TODO Should these be on the SO obejcts? (non-Javadoc)
 void setAction(RAMAction action)
          Set the action to be performed when passed to RAMSession#put(IRAMSessionObject, org.eclipse.core.runtime.IProgressMonitor) Accepts RAMAction.CREATE RAMAction.UPDATE RAMAction.DELETE
 void setConfiguration(java.lang.String configuration)
          Set the configration string.
 void setDescription(java.lang.String description)
           
 void setId(int id)
           
 void setName(java.lang.String name)
           
 void setPrivate(boolean isPrivate)
          TODO Should these be on the SO obejcts?
 void setRestricted(boolean restricted)
          TODO Should these be on the SO obejcts?
 void setURI(java.lang.String uri)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

createAttributeConstraint

public RAMAttributeConstraint createAttributeConstraint(RAMAssetAttribute attribute,
                                                        boolean required)
Creates a new attribute constraint on an asset type. This specifies if that an attribute is applicable and weather it is optional or required.

Since:
7.1

getAttributeConstraints

public RAMAttributeConstraint[] getAttributeConstraints()
Returns the list of attribute constraints set on this asset type

Since:
7.1

getDescription

public java.lang.String getDescription()
                                throws RAMRuntimeException
Overrides:
getDescription in class AssetType
Returns:
Returns the description.
Throws:
RAMRuntimeException

setDescription

public void setDescription(java.lang.String description)
Overrides:
setDescription in class AssetType
Parameters:
description - The description to set.

getId

public int getId()
          throws RAMRuntimeException
Description copied from class: AssetType
The internal id of the asset type within the repository.

Overrides:
getId in class AssetType
Returns:
Returns the id.
Throws:
RAMRuntimeException

setId

public void setId(int id)
Overrides:
setId in class AssetType
Parameters:
id - The id to set.

getName

public java.lang.String getName()
                         throws RAMRuntimeException
Overrides:
getName in class AssetType
Returns:
Returns the name.
Throws:
RAMRuntimeException

setName

public void setName(java.lang.String name)
Overrides:
setName in class AssetType
Parameters:
name - The name to set.

getURI

public java.lang.String getURI()
                        throws RAMRuntimeException
Overrides:
getURI in class AssetType
Returns:
Returns the uri.
Throws:
RAMRuntimeException

isDirty

public boolean isDirty()
Returns true if the Object has been modified from the copy on the server

Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

isPrivate

public boolean isPrivate()
TODO Should these be on the SO obejcts? (non-Javadoc)

See Also:
com.ibm.ram.common.data.AssetType#isPrivate()

isRestricted

public boolean isRestricted()
TODO Should these be on the SO obejcts? (non-Javadoc)

See Also:
com.ibm.ram.common.data.AssetType#isPrivate()

setPrivate

public void setPrivate(boolean isPrivate)
TODO Should these be on the SO obejcts?

See Also:
com.ibm.ram.common.data.AssetType#setPrivate(boolean)

setRestricted

public void setRestricted(boolean restricted)
TODO Should these be on the SO obejcts?

See Also:
com.ibm.ram.common.data.AssetType#setRestricted(boolean)

setURI

public void setURI(java.lang.String uri)
Overrides:
setURI in class AssetType
Parameters:
uri - The uri to set.

setConfiguration

public void setConfiguration(java.lang.String configuration)
Set the configration string. This is either null or empty string, or it is a valid XMI resource string (i.e. the contents of an XMI file). This will be the configuration of the constraints grouping for this asset type.

Parameters:
configuration - The configuration to set.
Since:
7.1

getConfiguration

public java.lang.String getConfiguration()
Get the configuration string, either null, or empty string, or a valid XMI file contents.

Returns:
Returns the configuration.
Since:
7.1
See Also:
setConfiguration(String)

getCommunityAssetTypes

public CommunityAssetType[] getCommunityAssetTypes()
Returns the list of Community scoped versions of this Asset Type

Since:
7.1

getCommunityAssetType

public CommunityAssetType getCommunityAssetType(CommunityInformation community)
Returns the list of Community scoped versions of this Asset Type.

Since:
7.1

createCommunityAssetType

public CommunityAssetType createCommunityAssetType(CommunityInformation community)
Returns the list of Community scoped versions of this Asset Type.

Since:
7.1

getAction

public RAMAction getAction()
Set the action to be performed on the session object. Each object will have it's own set of actions it will accept

Returns:

setAction

public void setAction(RAMAction action)
Set the action to be performed when passed to RAMSession#put(IRAMSessionObject, org.eclipse.core.runtime.IProgressMonitor) Accepts RAMAction.CREATE RAMAction.UPDATE RAMAction.DELETE

Parameters:
action -
Since:
7.1