de.ipk_gatersleben.bit.bi.edal.primary_data.file

Class PublicReference

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.primary_data.file.PublicReference

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

PublicReferenceImplementation

public class PublicReference
extends java.lang.Object
implements java.io.Serializable

Provide a public, long term stable ID for data referencing.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected PersistentIdentifier	identifierType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PublicReference() Default constructor, only for internal use.
protected	PublicReference(PrimaryDataEntityVersion entityVersion, PersistentIdentifier identifierType) Constructor generate a new PublicReference object and use the class that belongs to the PersistentIdentifier.

Method Summary

Modifier and Type	Method and Description
void	changeReleaseDate(java.util.Calendar releaseDate)
boolean	equals(java.lang.Object obj)
java.util.Calendar	getAcceptedDate() Getter for the accepted Date of this PublicReference
java.lang.String	getAssignedID()
java.util.Calendar	getCreationDate() Getter for the creation Date of this PublicReference
PersistentIdentifier	getIdentifierType() Getter for the PersistentIdentifier of this PublicReference.
java.lang.String	getInternalID()
PublicationStatus	getPublicationStatus() Function to check the publication status of this PublicReference.
Referenceable	getReferencable() Getter for the Referenceable type of this PublicReference:
java.util.Calendar	getRejectedDate() Getter for the rejected Date of this PublicReference
java.util.Calendar	getReleaseDate()
java.util.Calendar	getRequestedDate() Getter for the requested Date of this PublicReference
java.security.Principal	getRequestedPrincipal() Get the Principal of the person, who requested this PublicReference.
PrimaryDataEntityVersion	getVersion() Getter for the PrimaryDataEntityVersion of this PublicReference.
int	hashCode()
boolean	isPublic() Getter for the isPublic field.
protected void	setAcceptedDate(java.util.Calendar acceptedDate) Setter for the accepted date of this PublicReference.
protected void	setAssignedID(java.lang.String assignedID)
protected void	setCreationDate(java.util.Calendar creationDate) Setter for the creation date of this PublicReference.
protected void	setInternalID(java.lang.String internalID)
void	setPublic(javax.mail.internet.InternetAddress emailNotificationAddress) Setter for the isPublic field and use the default Workgroup.
void	setPublic(javax.mail.internet.InternetAddress emailNotificationAddress, java.util.Calendar releaseDate) Setter for the isPublic field.
protected void	setPublicationStatus(PublicationStatus publicationStatus) Internal setter for the PublicationStatus of this PublicReference.
protected void	setRejectedDate(java.util.Calendar rejectedDate) Setter for the rejected date of this PublicReference.
protected void	setReleaseDate(java.util.Calendar releaseDate)
protected void	setRequestedDate(java.util.Calendar requestedDate) Setter for the requested date of this PublicReference.
protected void	setRequestedPrincipal(java.security.Principal requestedPrincipal) Setter for the Principal that requested this PublicReference.
void	setVersion(PrimaryDataEntityVersion version) Setter for the PrimaryDataEntityVersion of this PublicReference.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

identifierType

protected PersistentIdentifier identifierType

Constructor Detail

PublicReference

protected PublicReference()

Default constructor, only for internal use.

PublicReference

protected PublicReference(PrimaryDataEntityVersion entityVersion,
                          PersistentIdentifier identifierType)
                   throws EdalException

Constructor generate a new PublicReference object and use the class that belongs to the PersistentIdentifier. Before creating a new PublicReference object the constructor calls the Referenceable.validateMetaData(PrimaryDataEntityVersion) method.

Parameters:

entityVersion - the current PrimaryDataEntityVersion for this PublicReference.

identifierType - the type of the PublicReference.

Throws:

EdalException - if unable to create new PublicReference.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAcceptedDate

public java.util.Calendar getAcceptedDate()

Getter for the accepted Date of this PublicReference

Returns:

the accepted date or null if the PublicReference was not yet accepted.

getAssignedID

public java.lang.String getAssignedID()
                               throws PublicReferenceException

Returns:

the assignedID

Throws:

PublicReferenceException - if no ID set

getCreationDate

public java.util.Calendar getCreationDate()

Getter for the creation Date of this PublicReference

Returns:

the creation date.

getIdentifierType

public PersistentIdentifier getIdentifierType()

Getter for the PersistentIdentifier of this PublicReference.

Returns:

the PersistentIdentifier to this PublicReference.

getPublicationStatus

public PublicationStatus getPublicationStatus()

Function to check the publication status of this PublicReference.

Returns:

the current status of the publication process of this PublicReference.

getReferencable

public Referenceable getReferencable()
                              throws EdalException

Getter for the Referenceable type of this PublicReference:

Returns:

the corresponding Referenceable object.

Throws:

EdalException - if unable to load the Referenceable class.

getRejectedDate

public java.util.Calendar getRejectedDate()

Getter for the rejected Date of this PublicReference

Returns:

the rejected date or null if the PublicReference was not yet rejected.

getRequestedDate

public java.util.Calendar getRequestedDate()

Getter for the requested Date of this PublicReference

Returns:

the requested date or null if the PublicReference was not yet requested.

getRequestedPrincipal

public java.security.Principal getRequestedPrincipal()

Get the Principal of the person, who requested this PublicReference.

Returns:

the Principal that requested this PublicReference .

getVersion

public PrimaryDataEntityVersion getVersion()

Getter for the PrimaryDataEntityVersion of this PublicReference.

Returns:

the PrimaryDataEntityVersion to this PublicReference.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isPublic

public boolean isPublic()

Getter for the isPublic field. Convenience function for external use.

Returns:

the isPublic field.

setAcceptedDate

protected void setAcceptedDate(java.util.Calendar acceptedDate)

Setter for the accepted date of this PublicReference.

Parameters:

acceptedDate - the date to set.

setAssignedID

protected void setAssignedID(java.lang.String assignedID)

Parameters:

assignedID - the assignedID to set

setCreationDate

protected void setCreationDate(java.util.Calendar creationDate)

Setter for the creation date of this PublicReference.

Parameters:

creationDate - the Date to set as creation date.

setPublic

public void setPublic(javax.mail.internet.InternetAddress emailNotificationAddress,
                      java.util.Calendar releaseDate)
               throws PublicReferenceException

Setter for the isPublic field. Convenience function for external use.

Parameters:

emailNotificationAddress - the address for email notifications

releaseDate - the release date

Throws:

PublicReferenceException - if unable to request this PublicReference to set public.

setPublic

public void setPublic(javax.mail.internet.InternetAddress emailNotificationAddress)
               throws PublicReferenceException

Setter for the isPublic field and use the default Workgroup. Convenience function for external use.

Parameters:

emailNotificationAddress - the address for email notifications

Throws:

PublicReferenceException - if unable to request this PublicReference to set public.

setRejectedDate

protected void setRejectedDate(java.util.Calendar rejectedDate)

Setter for the rejected date of this PublicReference.

Parameters:

rejectedDate - the date to set.

setRequestedDate

protected void setRequestedDate(java.util.Calendar requestedDate)

Setter for the requested date of this PublicReference.

Parameters:

requestedDate - the Date to set as requested Date.

setRequestedPrincipal

protected void setRequestedPrincipal(java.security.Principal requestedPrincipal)

Setter for the Principal that requested this PublicReference.

Parameters:

requestedPrincipal - the Principal to set.

setVersion

public void setVersion(PrimaryDataEntityVersion version)

Setter for the PrimaryDataEntityVersion of this PublicReference.

Parameters:

version - the PrimaryDataEntityVersion to set.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setPublicationStatus

protected void setPublicationStatus(PublicationStatus publicationStatus)

Internal setter for the PublicationStatus of this PublicReference.

Parameters:

publicationStatus - the publicationStatus to set

getInternalID

public java.lang.String getInternalID()

Returns:

the internalID

setInternalID

protected void setInternalID(java.lang.String internalID)

Parameters:

internalID - the internalID to set

getReleaseDate

public java.util.Calendar getReleaseDate()

Returns:

the releaseDate

setReleaseDate

protected void setReleaseDate(java.util.Calendar releaseDate)

Parameters:

releaseDate - the releaseDate to set

changeReleaseDate

public void changeReleaseDate(java.util.Calendar releaseDate)