PublicReference (eDAL-MetaDataAPI 2.3.8 API)

java.lang.Object
- de.ipk_gatersleben.bit.bi.edal.primary_data.file.PublicReference

All Implemented Interfaces:

Serializable
```
public class PublicReference
extends Object
implements Serializable
```
Provide a public, long term stable ID for data referencing.

Author:

arendd

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected PersistentIdentifier identifierType

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

Methods
Modifier and Type	Method and Description
`void`	`changeReleaseDate(Calendar releaseDate)`
`boolean`	`equals(Object obj)`
`Calendar`	`getAcceptedDate()` Getter for the accepted Date of this `PublicReference`
`String`	`getAssignedID()`
`Calendar`	`getCreationDate()` Getter for the creation Date of this `PublicReference`
`PersistentIdentifier`	`getIdentifierType()` Getter for the `PersistentIdentifier` of this `PublicReference`.
`String`	`getInternalID()`
`PublicationStatus`	`getPublicationStatus()` Function to check the publication status of this `PublicReference`.
`EdalReferenceable`	`getReferencable()` Getter for the `EdalReferenceable` type of this `PublicReference`:
`Calendar`	`getRejectedDate()` Getter for the rejected Date of this `PublicReference`
`Calendar`	`getReleaseDate()`
`Calendar`	`getRequestedDate()` Getter for the requested Date of this `PublicReference`
`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(Calendar acceptedDate)` Setter for the accepted date of this `PublicReference`.
`protected void`	`setAssignedID(String assignedID)`
`protected void`	`setCreationDate(Calendar creationDate)` Setter for the creation date of this `PublicReference`.
`protected void`	`setInternalID(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, Calendar releaseDate)` Setter for the `isPublic` field.
`protected void`	`setPublicationStatus(PublicationStatus publicationStatus)` Internal setter for the `PublicationStatus` of this PublicReference.
`protected void`	`setRejectedDate(Calendar rejectedDate)` Setter for the rejected date of this `PublicReference`.
`protected void`	`setReleaseDate(Calendar releaseDate)`
`protected void`	`setRequestedDate(Calendar requestedDate)` Setter for the requested date of this `PublicReference`.
`protected void`	`setRequestedPrincipal(Principal requestedPrincipal)` Setter for the `Principal` that requested this `PublicReference`.
`void`	`setVersion(PrimaryDataEntityVersion version)` Setter for the `PrimaryDataEntityVersion` of this `PublicReference`.
`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 EdalReferenceable.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(Object obj)
```
    Overrides:
    
    equals in class Object
  - getAcceptedDate
```
public 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 String getAssignedID()
                     throws PublicReferenceException
```
    Returns:
    the assignedID
    
    Throws:
    
    PublicReferenceException
  - getCreationDate
```
public 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 EdalReferenceable getReferencable()
                                  throws EdalException
```
    Getter for the EdalReferenceable type of this PublicReference:
    
    Returns:
    the corresponding EdalReferenceable object.
    
    Throws:
    
    EdalException - if unable to load the EdalReferenceable class.
  - getRejectedDate
```
public 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 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 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 Object
  - isPublic
```
public boolean isPublic()
```
    Getter for the isPublic field.
    Convenience function for external use. return the isPublic field.
  - setAcceptedDate
```
protected void setAcceptedDate(Calendar acceptedDate)
```
    Setter for the accepted date of this PublicReference.
    
    Parameters:
    acceptedDate - the date to set.
  - setAssignedID
```
protected void setAssignedID(String assignedID)
```
    Parameters:
    assignedID - the assignedID to set
  - setCreationDate
```
protected void setCreationDate(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,
             Calendar releaseDate)
               throws PublicReferenceException
```
    Setter for the isPublic field.
    Convenience function for external use.
    
    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.
    
    Throws:
    
    PublicReferenceException - if unable to request this PublicReference to set public.
  - setRejectedDate
```
protected void setRejectedDate(Calendar rejectedDate)
```
    Setter for the rejected date of this PublicReference.
    
    Parameters:
    rejectedDate - the date to set.
  - setRequestedDate
```
protected void setRequestedDate(Calendar requestedDate)
```
    Setter for the requested date of this PublicReference.
    
    Parameters:
    requestedDate - the Date to set as requested Date.
  - setRequestedPrincipal
```
protected void setRequestedPrincipal(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 String toString()
```
    Overrides:
    
    toString in class Object
  - setPublicationStatus
```
protected void setPublicationStatus(PublicationStatus publicationStatus)
```
    Internal setter for the PublicationStatus of this PublicReference.
    
    Parameters:
    publicationStatus - the publicationStatus to set
  - getInternalID
```
public String getInternalID()
```
    Returns:
    the internalID
  - setInternalID
```
protected void setInternalID(String internalID)
```
    Parameters:
    internalID - the internalID to set
  - getReleaseDate
```
public Calendar getReleaseDate()
```
    Returns:
    the releaseDate
  - setReleaseDate
```
protected void setReleaseDate(Calendar releaseDate)
```
    Parameters:
    releaseDate - the releaseDate to set
  - changeReleaseDate
```
public void changeReleaseDate(Calendar releaseDate)
```

Class PublicReference

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

identifierType

Constructor Detail

PublicReference

PublicReference

Method Detail

equals

getAcceptedDate

getAssignedID

getCreationDate

getIdentifierType

getPublicationStatus

getReferencable

getRejectedDate

getRequestedDate

getRequestedPrincipal

getVersion

hashCode

isPublic

setAcceptedDate

setAssignedID

setCreationDate

setPublic

setPublic

setRejectedDate

setRequestedDate

setRequestedPrincipal

setVersion

toString

setPublicationStatus

getInternalID

setInternalID

getReleaseDate

setReleaseDate

changeReleaseDate