Package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto

Class Project

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Project

All Implemented Interfaces:

IIdentifierHolder, Serializable

@JsonObject("Project")
public final class Project
extends Object
implements Serializable, IIdentifierHolder

Immutable value object representing a project. A project is specified by its code and the code of the space to which it belongs.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Project(Long id, String permId, String spaceCode, String code, String description)	Creates a new instance for the specified tech id, perm id, space code and project code.
Project(Long id, String permId, String spaceCode, String code, String description, EntityRegistrationDetails registrationDetails)	Creates a new instance for the specified space code and project code.
Project(String spaceCode, String code)	Creates a new instance for the specified space code and project code.
Project(String spaceCode, String code, EntityRegistrationDetails registrationDetails)	Creates a new instance for the specified tech id, perm id, space code and project code.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getCode()	Returns the project code.
String	getDescription()	Returns the project description.
Long	getId()	Returns the techical database id of the project.
String	getIdentifier()
String	getPermId()	Returns the permanent id of the project.
EntityRegistrationDetails	getRegistrationDetails()	Return the vocabulary term registration details.
String	getSpaceCode()	Returns the space code.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Project

public Project(Long id,
 String permId,
 String spaceCode,
 String code,
 String description)

Creates a new instance for the specified tech id, perm id, space code and project code.

Throws:

IllegalArgumentException - if either the code or the space code is null or an empty string.

Project

public Project(String spaceCode,
 String code)

Creates a new instance for the specified space code and project code.

Throws:

IllegalArgumentException - if either the code or the space code is null or an empty string.

Project

public Project(String spaceCode,
 String code,
 EntityRegistrationDetails registrationDetails)

Creates a new instance for the specified tech id, perm id, space code and project code.

Throws:

IllegalArgumentException - if either the code or the space code is null or an empty string.

Project

public Project(Long id,
 String permId,
 String spaceCode,
 String code,
 String description,
 EntityRegistrationDetails registrationDetails)

Creates a new instance for the specified space code and project code.

Throws:

IllegalArgumentException - if either the code or the space code is null or an empty string.

Method Details

getId

public Long getId()

Returns the techical database id of the project.

Since:

1.22

getPermId

public String getPermId()

Returns the permanent id of the project.

Since:

1.22

getSpaceCode

public String getSpaceCode()

Returns the space code.

getCode

public String getCode()

Returns the project code.

getDescription

public String getDescription()

Returns the project description.

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface IIdentifierHolder

getRegistrationDetails

public EntityRegistrationDetails getRegistrationDetails()

Return the vocabulary term registration details.

Since:

1.11

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object