com.ibm.ram.client
Class RAMRelationshipType

java.lang.Object
  extended by com.ibm.ram.common.data.RelationshipType
      extended by com.ibm.ram.client.RAMRelationshipType

public class RAMRelationshipType
extends RelationshipType

Represents a relationship type

Since:
7.1
Author:
kbauer

Method Summary
 RAMAction getAction()
          Set the action to be performed on the session object.
 java.lang.String getDisplayName()
          Get the display name to use for the forward relationship.
 java.lang.String getName()
          Get the name of the forward relationship.
 java.lang.String getReverseName()
          Get the reverse name (the opposite relationship).
 RelationshipType getReverseType()
          Return the reverse relationship type.
 RAMSession getSession()
          Returns the session this type was fetched from
 boolean isDirty()
          Returns true if this Relationship Type has been modified
 boolean isPreferredEnd()
          Is this the preferred end.
 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.DELETE
 void setDisplayName(java.lang.String displayName)
           
 void setName(java.lang.String name)
           
 void setPreferredEnd(boolean preferredEnd)
          Set if the preferred end.
 void setReverseName(java.lang.String reverseName)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getDisplayName

public java.lang.String getDisplayName()
                                throws RAMRuntimeException
Description copied from class: RelationshipType
Get the display name to use for the forward relationship.

Overrides:
getDisplayName in class RelationshipType
Returns:
Returns the displayName.
Throws:
RAMRuntimeException

setDisplayName

public void setDisplayName(java.lang.String displayName)
Overrides:
setDisplayName in class RelationshipType
Parameters:
displayName - The displayName to set.

getName

public java.lang.String getName()
                         throws RAMRuntimeException
Description copied from class: RelationshipType
Get the name of the forward relationship. This is the name that actually goes into the manifest.

Overrides:
getName in class RelationshipType
Returns:
Returns the name.
Throws:
RAMRuntimeException

setName

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

toString

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

getReverseType

public RelationshipType getReverseType()
Return the reverse relationship type.

Since:
7.1

getSession

public RAMSession getSession()
Returns the session this type was fetched from

Since:
7.1

getReverseName

public java.lang.String getReverseName()
Description copied from class: RelationshipType
Get the reverse name (the opposite relationship). This is the name that actually goes into the manifest.

Overrides:
getReverseName in class RelationshipType
Returns:
Returns the reverseName.

isDirty

public boolean isDirty()
Returns true if this Relationship Type has been modified

Returns:
Since:
7.1

isPreferredEnd

public boolean isPreferredEnd()
Description copied from class: RelationshipType
Is this the preferred end.

Overrides:
isPreferredEnd in class RelationshipType
Returns:
true if this is the preferred end.

setPreferredEnd

public void setPreferredEnd(boolean preferredEnd)
Description copied from class: RelationshipType
Set if the preferred end.

Overrides:
setPreferredEnd in class RelationshipType

setReverseName

public void setReverseName(java.lang.String reverseName)
Overrides:
setReverseName in class RelationshipType
Parameters:
reverseName - The reverseName to set.

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

Parameters:
action -
Since:
7.1