|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.datapower.wamt.clientAPI.DomainVersion
public class DomainVersion
Internal use only
A class to track the versions of a Domain. There may be multiple DomainVersions for a single Domain. This object (by way of theStoredDomainVersion
member) has the
Blob
that contains the data that represents this domain's
configuration.
If the domain is not the domain named "default", then
the Blob is a generic domain export, the same you would get via the
WebGUI.
For more information refer to the javadoc for Domain
and
Version
.
Domain
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT_2009_2013
|
Fields inherited from interface com.ibm.datapower.wamt.clientAPI.Version |
---|
COPYRIGHT_2009_2010, SCM_REVISION |
Method Summary | |
---|---|
ProgressContainer |
diff(DomainVersion that)
Generate a background task to get a visual representation of the differences of a domain between two versions. |
java.lang.String |
getAbsoluteDisplayName()
Get a human-readable name that represents this object. |
Blob |
getBlob()
Get the Blob that is attached to this Version. |
static DomainVersion |
getByPrimaryKey(java.lang.String targetKey)
Retrieve a reference to the DomainVersion that has the specified primary key. |
Domain |
getDomain()
Get the Domain that this object is a Version of. |
java.lang.String |
getPrimaryKey()
|
java.lang.String |
getRelativeDisplayName()
Get a human-readable name that represents this object. |
java.util.Date |
getTimestamp()
Get the timestamp that signifies when the Version was created in the Manager. |
java.lang.String |
getUserComment()
Get the user comment that corresponds to this Version. |
Versionable |
getVersionedObject()
Get a reference to the object that this Version is a version of. |
int |
getVersionNumber()
Get the version number that this Version object represents. |
void |
setUserComment(java.lang.String userComment)
This is the method to set the user comment that can be later retrieved via Version.getUserComment() . |
java.lang.String |
toString()
Get a String representation of this object for the purpose of debugging or tracing. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT_2009_2013
Method Detail |
---|
public Versionable getVersionedObject() throws DeletedException
Version
DomainVersion.getVersionedObject()
should
return a Domain
, which is the parent object. This should
be a reminder for the subclass to implement the method getDomain()
or getFirmware() that would return a typed object instead
of a generic one. It isn't expected that a caller would actually use this
method.
getVersionedObject
in interface Version
public Domain getDomain() throws DeletedException
getVersionedObject()
, except that it returns an object with
type Domain
instead of the parent type
Versionable
.
public java.lang.String getPrimaryKey() throws DeletedException
public static DomainVersion getByPrimaryKey(java.lang.String targetKey)
targetKey
- the primary key to search for
null
if no DomainVersion with the specified
primary key was found.getPrimaryKey()
public ProgressContainer diff(DomainVersion that) throws DeletedException, DatastoreException, FullException
that
- the other DomainVersion to be used for comparison to "this"
public int getVersionNumber() throws DeletedException
Version
setVersionNumber(int)
method. The combination
of version number and Object reference forms the primary key for a
Version object in the Manager.
getVersionNumber
in interface Version
public java.util.Date getTimestamp() throws DeletedException
Version
setTimestamp(Date)
method.
getTimestamp
in interface Version
public java.lang.String getUserComment() throws DeletedException
Version
getUserComment
in interface Version
Version.setUserComment(String)
public void setUserComment(java.lang.String userComment) throws DeletedException, DatastoreException, DirtySaveException
Version
Version.getUserComment()
. Calling this method will cause the
comment to be written to the persisted datastore.
setUserComment
in interface Version
userComment
- the user-defined comment to attach to this Version. It may
have reference to a new function, bug fix, change management or
problem management ticket, etc. This is a freeform field of
unlimited length.Version.getUserComment()
public Blob getBlob() throws DeletedException
Version
getBlob
in interface Version
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getRelativeDisplayName()
public java.lang.String getAbsoluteDisplayName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |