org.odpi.openmetadata.repositoryservices.rest.properties

Class RelationshipCreateRequest

java.lang.Object

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest

org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipCreateRequest

All Implemented Interfaces:

Serializable

public class RelationshipCreateRequest
extends OMRSAPIRequest

RelationshipCreateRequest provides the bean to hold all of the properties needed to create a new relationship.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RelationshipCreateRequest() Default constructor
RelationshipCreateRequest(RelationshipCreateRequest template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getEntityOneGUID() Return the unique identifier (GUID) for the first entity linked by the relationship.
String	getEntityTwoGUID() Return the unique identifier (GUID) for the second entity linked by the relationship.
InstanceProperties	getInitialProperties() Return the list of properties for the new relationship.
InstanceStatus	getInitialStatus() Return the initial status for the new relationship.
String	getMetadataCollectionId() Return the metadata collection id for this new relationship
String	getMetadataCollectionName() Return the name of the metadata collection for this new relationship.
String	getRelationshipTypeGUID() Return the type of the new relationship.
int	hashCode() Create a hash code for this element type.
void	setEntityOneGUID(String entityOneGUID) Set up the unique identifier (GUID) for the first entity linked by the relationship.
void	setEntityTwoGUID(String entityTwoGUID) Set up the unique identifier (GUID) for the second entity linked by the relationship.
void	setInitialProperties(InstanceProperties initialProperties) Set up the initial properties for the relationship.
void	setInitialStatus(InstanceStatus initialStatus) Set up the initial status for the new relationship.
void	setMetadataCollectionId(String metadataCollectionId) Set up the metadata collection id for this new relationship.
void	setMetadataCollectionName(String metadataCollectionName) Set up the name of the metadata collection for this new relationship.
void	setRelationshipTypeGUID(String relationshipTypeGUID) Set up the type of the new relationship.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelationshipCreateRequest

public RelationshipCreateRequest()

Default constructor

RelationshipCreateRequest

public RelationshipCreateRequest(RelationshipCreateRequest template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getRelationshipTypeGUID

public String getRelationshipTypeGUID()

Return the type of the new relationship.

Returns:

String guid

setRelationshipTypeGUID

public void setRelationshipTypeGUID(String relationshipTypeGUID)

Set up the type of the new relationship.

Parameters:

relationshipTypeGUID - String guid

getInitialProperties

public InstanceProperties getInitialProperties()

Return the list of properties for the new relationship.

Returns:

instance properties object

setInitialProperties

public void setInitialProperties(InstanceProperties initialProperties)

Set up the initial properties for the relationship.

Parameters:

initialProperties - InstanceProperties object

getEntityOneGUID

public String getEntityOneGUID()

Return the unique identifier (GUID) for the first entity linked by the relationship.

Returns:

entity guid

setEntityOneGUID

public void setEntityOneGUID(String entityOneGUID)

Set up the unique identifier (GUID) for the first entity linked by the relationship.

Parameters:

entityOneGUID - entity guid

getEntityTwoGUID

public String getEntityTwoGUID()

Return the unique identifier (GUID) for the second entity linked by the relationship.

Returns:

entity guid

setEntityTwoGUID

public void setEntityTwoGUID(String entityTwoGUID)

Set up the unique identifier (GUID) for the second entity linked by the relationship.

Parameters:

entityTwoGUID - entity guid

getInitialStatus

public InstanceStatus getInitialStatus()

Return the initial status for the new relationship.

Returns:

instance status enum

setInitialStatus

public void setInitialStatus(InstanceStatus initialStatus)

Set up the initial status for the new relationship.

Parameters:

initialStatus - instance status enum

getMetadataCollectionId

public String getMetadataCollectionId()

Return the metadata collection id for this new relationship

Returns:

guid

setMetadataCollectionId

public void setMetadataCollectionId(String metadataCollectionId)

Set up the metadata collection id for this new relationship. This field is optional for addRelationship and mandatory for addExternalRelationship.

Parameters:

metadataCollectionId - guid

getMetadataCollectionName

public String getMetadataCollectionName()

Return the name of the metadata collection for this new relationship.

Returns:

name

setMetadataCollectionName

public void setMetadataCollectionName(String metadataCollectionName)

Set up the name of the metadata collection for this new relationship.

Parameters:

metadataCollectionName - name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class Object

Returns:

int hash code