com.esri.gpt.catalog.publication
Class PublicationRecord

java.lang.Object
  com.esri.gpt.catalog.publication.PublicationRecord

public class PublicationRecord
extends Object

Describes the basic properties for a metadata document that is about to be published.

Constructor Summary

PublicationRecord()
Default constructor.

Method Summary

String	getAlternativeTitle() Gets alternative title.
String	getApprovalStatus() Gets the approval status.
boolean	getAutoApprove() Gets the status indicating if a new document should be automatically approved.
String	getFileIdentifier() Gets the file identifier.
boolean	getIndexEnabled() Checks if index creation is enabled.
boolean	getLockTitle() Checks if updating title is enabled.
String	getPublicationMethod() Gets the publication method.
String	getSiteUuid() Gets harvest site UUID.
String	getSourceFileName() Gets the source file name (applicable for uploaded files).
String	getSourceUri() Gets the source URI for the document.
String	getSourceXml() Gets the source XML string.
boolean	getUpdateOnlyIfXmlHasChanged() Gets the status indicating if a document should be updated only if the XML has changed.
String	getUuid() Gets the UUID for the document.
boolean	getWasDocumentReplaced() Gets the status indicating if a document was replaced within the catalog.
boolean	getWasDocumentUnchanged() Gets the status indicating if a document was unchanged (no XML change, no database update tool place).
void	setAlternativeTitle(String title) Sets alternative title.
void	setApprovalStatus(String status) Sets the approval status.
void	setAutoApprove(boolean autoApprove) Sets the status indicating if a new document should be automatically approved.
void	setFileIdentifier(String id) Sets the file identifier.
void	setIndexEnabled(boolean indexEnabled) Enables index creation.
void	setLockTitle(boolean lockTitle) Enables updating title.
void	setPublicationMethod(String method) Sets the publication method.
void	setSiteUuid(String siteUuid) Sets harvest site UUID.
void	setSourceFileName(String fileName) Sets the source file name (applicable for uploaded files).
void	setSourceUri(String uri) Sets the source URI for the document.
void	setSourceXml(String xml) Sets the source XML string.
void	setUpdateOnlyIfXmlHasChanged(boolean onlyIfChanged) Sets the status indicating if a document should be updated only if the XML has changed.
void	setUuid(String uuid) Sets the UUID for the document.
protected void	setWasDocumentReplaced(boolean wasReplaced) Sets the status indicating if a document was replaced within the catalog.
protected void	setWasDocumentUnchanged(boolean wasUnchanged) Sets the status indicating if a document was unchanged (no XML change, no database update tool place).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PublicationRecord

public PublicationRecord()

Default constructor.

Method Detail

getAutoApprove

public boolean getAutoApprove()

Gets the status indicating if a new document should be automatically approved.

Returns:

true if a new document should be automatically approved

setAutoApprove

public void setAutoApprove(boolean autoApprove)

Sets the status indicating if a new document should be automatically approved.

Parameters:

autoApprove - true if a new document should be automatically approved

getApprovalStatus

public String getApprovalStatus()

Gets the approval status.

Returns:

the approval status

setApprovalStatus

public void setApprovalStatus(String status)

Sets the approval status.

Parameters:

status - the approval status

getFileIdentifier

public String getFileIdentifier()

Gets the file identifier.
The file identifier is typically associated with ISO-19139 documents.

Returns:

the file identifier

setFileIdentifier

public void setFileIdentifier(String id)

Sets the file identifier.
The file identifier is typically associated with ISO-19139 documents.

Parameters:

id - the file identifier

getPublicationMethod

public String getPublicationMethod()

Gets the publication method.

Returns:

the publication method

setPublicationMethod

public void setPublicationMethod(String method)

Sets the publication method.

Parameters:

method - the publication method

getSourceFileName

public String getSourceFileName()

Gets the source file name (applicable for uploaded files).

Returns:

the source file name

setSourceFileName

public void setSourceFileName(String fileName)

Sets the source file name (applicable for uploaded files).

Parameters:

fileName - the source file name

getSiteUuid

public String getSiteUuid()

Gets harvest site UUID.

Returns:

the harvest site UUID

setSiteUuid

public void setSiteUuid(String siteUuid)

Sets harvest site UUID.

Parameters:

siteUuid - harvest site UUID

getSourceUri

public String getSourceUri()

Gets the source URI for the document.

Returns:

the source URI

setSourceUri

public void setSourceUri(String uri)

Sets the source URI for the document.

Parameters:

uri - the source URI

getSourceXml

public String getSourceXml()

Gets the source XML string.

Returns:

the source XML string

setSourceXml

public void setSourceXml(String xml)

Sets the source XML string.

Parameters:

xml - the source XML string

getUpdateOnlyIfXmlHasChanged

public boolean getUpdateOnlyIfXmlHasChanged()

Gets the status indicating if a document should be updated only if the XML has changed.

Returns:

true if a document should be updated only if the XML has changed

setUpdateOnlyIfXmlHasChanged

public void setUpdateOnlyIfXmlHasChanged(boolean onlyIfChanged)

Sets the status indicating if a document should be updated only if the XML has changed.

Parameters:

onlyIfChanged - true if a document should be updated only if the XML has changed

getUuid

public String getUuid()

Gets the UUID for the document.

Returns:

the UUID

setUuid

public void setUuid(String uuid)

Sets the UUID for the document.

Parameters:

uuid - the UUID

getWasDocumentReplaced

public boolean getWasDocumentReplaced()

Gets the status indicating if a document was replaced within the catalog.

Returns:

true if the document was replaced

setWasDocumentReplaced

protected void setWasDocumentReplaced(boolean wasReplaced)

Sets the status indicating if a document was replaced within the catalog.

Parameters:

wasReplaced - true if the document was replaced

getWasDocumentUnchanged

public boolean getWasDocumentUnchanged()

Gets the status indicating if a document was unchanged (no XML change, no database update tool place).

Returns:

true if the document was unchanged

setWasDocumentUnchanged

protected void setWasDocumentUnchanged(boolean wasUnchanged)

Sets the status indicating if a document was unchanged (no XML change, no database update tool place).

Parameters:

wasUnchanged - true if the document was unchanged

getAlternativeTitle

public String getAlternativeTitle()

Gets alternative title. This is a title provided by the user (not extracted from the resource). Used only when dealing with registered resource. If set it overrides possible title from the resource.

Returns:

alternative title

setAlternativeTitle

public void setAlternativeTitle(String title)

Sets alternative title. This is a title provided by the user (not extracted from the resource). Used only when dealing with registered resource. If set it overrides possible title from the resource.

Parameters:

title - alternative title

getLockTitle

public boolean getLockTitle()

Checks if updating title is enabled. Used only when dealing with registered resources.

Returns:

true if updating title is enabled

setLockTitle

public void setLockTitle(boolean lockTitle)

Enables updating title. Used only when dealing with registered resources.

Parameters:

lockTitle - true to enable updating title

getIndexEnabled

public boolean getIndexEnabled()

Checks if index creation is enabled. Default: true.

Returns:

true if index creation is enabled

setIndexEnabled

public void setIndexEnabled(boolean indexEnabled)

Enables index creation. Default: true.

Parameters:

indexEnabled - true to enable index creation