oracle.adf.share.sandbox

Class MetadataRevision

java.lang.Object

oracle.adf.share.sandbox.MetadataRevision

Direct Known Subclasses:

MetadataRevisionPortable

public class MetadataRevision
extends java.lang.Object

A universal version of metadata revised through customization.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID_KEY The preferred key to identify the metadata revision ID in a session.

Method Summary

Modifier and Type	Method and Description
static MetadataRevision	create(MetadataRevisionNoteURI noteURI) Creates a new revision in the local history of metadata revisions.
static MetadataRevision	create(java.lang.String noteURI) Creates a new revision in the local history of metadata revisions.
MetadataRevisionPortable	export() Exports this revision into a portable which can later be published in another host.
static MetadataRevision	get(java.lang.String revisionId) Returns the revision in the local history for a given ID.
java.lang.String	getFromHostId() Returns the ID of the host where this revision is imported from.
java.lang.String	getHostId() Returns the ID of the host where this revision is created.
java.lang.String	getId() Returns the ID of this revision.
static MetadataRevision	getLatest() Gets the latest metadata revision in the local history.
static MetadataRevision	getLatest(java.lang.String fromHostId) Gets the latest revision imported from a host.
static java.lang.String	getLocalHostId() Gets the ID of the local host where this class stores the metadata revisions.
java.lang.String	getNote() Returns the note URI of this revision.
MetadataRevisionNoteURI	getNoteURI() Returns the parsed note URI of this revision.
java.util.Date	getRecordDate() Returns the date when this revision is recorded in the local history.
java.lang.String	getRecordedBy() Returns the user that records this revision in the local history.
java.util.Map<java.lang.String,MetadataRepositoryBaseline>	getRepositoryBaselines() Returns the associated repository baselines.
java.lang.String	getSandboxName() Returns the name of the sandbox if the note of this revision is associated with a sandbox.
static java.util.List<MetadataRevision>	list(java.util.Date startDateExclusive, java.util.Date endDateExclusive, int maxListSize) Returns a list of metadata revisions from the local history.
static java.util.List<MetadataRevision>	listAfter(MetadataRevision revision) Lists all revisions in the local history after a revision.
static java.util.Map<MetadataRepositoryBaseline,MetadataRevision>	listMetadataRepositoryBaselines(java.lang.String repositoryId, java.util.Date startDateExclusive, java.util.Date endDateExclusive, int maxSize) Returns distinct baselines of a repository from the latest to the oldest and the revisions they first appear in.
java.lang.String	toString() Returns a String representation of this revision.

Methods inherited from class java.lang.Object

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

Field Detail

ID_KEY

public static final java.lang.String ID_KEY

The preferred key to identify the metadata revision ID in a session.

See Also:

Constant Field Values

Method Detail

getId

public final java.lang.String getId()

Returns the ID of this revision.

Returns:

the ID of this revision

getHostId

public final java.lang.String getHostId()

Returns the ID of the host where this revision is created.

Returns:

the ID of the host where this revision is created

getFromHostId

public final java.lang.String getFromHostId()

Returns the ID of the host where this revision is imported from.

Returns:

the ID of the host where this revision is imported from

getRepositoryBaselines

public java.util.Map<java.lang.String,MetadataRepositoryBaseline> getRepositoryBaselines()

Returns the associated repository baselines.

Returns:

the associated repository baselines; the keys are the IDs of the repositories

getRecordDate

public java.util.Date getRecordDate()

Returns the date when this revision is recorded in the local history.

Returns:

the date when this revision is recorded in the local history

getRecordedBy

public java.lang.String getRecordedBy()

Returns the user that records this revision in the local history.

Returns:

the user that records this revision in the local history

getNote

public java.lang.String getNote()

Returns the note URI of this revision.

Returns:

the note URI of this revision; null if there is no note

getNoteURI

public MetadataRevisionNoteURI getNoteURI()

Returns the parsed note URI of this revision.

Returns:

the parsed note URI of this revision; null if there is no note

getSandboxName

public java.lang.String getSandboxName()

Returns the name of the sandbox if the note of this revision is associated with a sandbox.

Returns:

the name of the sandbox if the note of this revision is associated with a sandbox; null otherwise. If the sandbox indicated by the URI cannot be found, then the raw URI that contains the ID of the sandbox is returned.

Throws:

java.lang.UnsupportedOperationException - if this method is not supported

export

public MetadataRevisionPortable export()

Exports this revision into a portable which can later be published in another host.

Returns:

the exported metadata revision

toString

public java.lang.String toString()

Returns a String representation of this revision. A connection to the host that originally defines this revision may be needed for this method to return the correct representation because some information in the representation is lazily loaded.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this revision

getLocalHostId

public static java.lang.String getLocalHostId()

Gets the ID of the local host where this class stores the metadata revisions.

Returns:

the ID of the local host where this class stores the metadata revisions

Throws:

java.lang.IllegalStateException - if the ID cannot be retrieved due to an error

get

public static MetadataRevision get(java.lang.String revisionId)

Returns the revision in the local history for a given ID.

Parameters:

revisionId - the ID of the revision

Returns:

the revision in the local history for the given ID; null if no such ID is found in the local history

Throws:

java.lang.IllegalArgumentException - if the given ID is null

listAfter

public static java.util.List<MetadataRevision> listAfter(MetadataRevision revision)

Lists all revisions in the local history after a revision.

Parameters:

revision - the revision immediately before the returned list in the local history

Returns:

all revisions in the local history after the specified revision

Throws:

java.lang.IllegalArgumentException - if the specified revision is null

getLatest

public static MetadataRevision getLatest(java.lang.String fromHostId)

Gets the latest revision imported from a host.

Parameters:

fromHostId - the ID of the host where the returned revision is imported from

Returns:

the latest revision from the given host; null if the local history of revisions does not contain any revision from the given host, or if there is no local history of metadata revisions

Throws:

java.lang.IllegalArgumentException - if the given host ID is null

getLatest

public static MetadataRevision getLatest()

Gets the latest metadata revision in the local history.

Returns:

the latest metadata revision in the local history; null if there is no history

create

public static MetadataRevision create(java.lang.String noteURI)

Creates a new revision in the local history of metadata revisions.

Parameters:

noteURI - the revision note URI; null is allowed.

Returns:

the newly created revision in the local history

Throws:

java.lang.UnsupportedOperationException - if the current application context does not support the creation of new revisions

create

public static MetadataRevision create(MetadataRevisionNoteURI noteURI)

Creates a new revision in the local history of metadata revisions.

Parameters:

noteURI - the revision note URI; null is allowed.

Returns:

the newly created revision in the local history

Throws:

java.lang.UnsupportedOperationException - if the current application context does not support the creation of new revisions

list

public static java.util.List<MetadataRevision> list(java.util.Date startDateExclusive,
                                                    java.util.Date endDateExclusive,
                                                    int maxListSize)

Returns a list of metadata revisions from the local history.

Parameters:

startDateExclusive - the low cutoff date. If specified, only the revisions recorded after the date are returned. If null is passed in, the low cutoff date is January 1, 1970, 00:00:00 GMT.

endDateExclusive - the high cutoff date. If specified, only the revisions recorded before the date are returned. If null is passed in, roughly the time of the invocation of this method will be the high cutoff date.

maxListSize - the maximum size of the returned list, a negative number if all revisions before the cutoff date should be returned

Returns:

the list of metadata revisions in the given range from the latest to the oldest, an empty list if no revision is found before the cutoff date, or if the given maximum size is zero

Throws:

java.lang.UnsupportedOperationException - if this method is not supported

listMetadataRepositoryBaselines

public static java.util.Map<MetadataRepositoryBaseline,MetadataRevision> listMetadataRepositoryBaselines(java.lang.String repositoryId,
                                                                                                         java.util.Date startDateExclusive,
                                                                                                         java.util.Date endDateExclusive,
                                                                                                         int maxSize)

Returns distinct baselines of a repository from the latest to the oldest and the revisions they first appear in.

Parameters:

repositoryId - the ID of the repository

startDateExclusive - the low cutoff date. If specified, only the baselines recorded after the date are returned. If null is passed in, the low cutoff date is January 1, 1970, 00:00:00 GMT.

endDateExclusive - the high cutoff date. If specified, only the baselines recorded before the date are returned. If null is passed in, roughly the time of the invocation of this method will be the high cutoff date.

maxSize - the maximum size of the returned map, a negative number if all revisions before the cutoff date should be returned

Returns:

the distinct baselines of the given repository from the latest to the oldest and the revisions they first appear in, an empty list if no revision is found before the cutoff date, or if the given maximum size is zero

Throws:

java.lang.IllegalArgumentException - if the given repository ID is null

java.lang.UnsupportedOperationException - if this method is not supported