wt.viewmarkup
Class PublishingProhibition

java.lang.Object
  wt.viewmarkup.PublishingProhibition

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class PublishingProhibition

extends Object

implements Persistable, Externalizable

Identifies Representables that are unpublishable for some reason, usually either because they are so big and take too long to publish or because they caused a publishing error and we need to disable the automatic retry that would try to republish them over and over, always generating the same publishing error.

Use the newPublishingProhibition static factory method(s), not the PublishingProhibition constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private String	description
static String	DESCRIPTION Label for the attribute; Describes why the Representable is not publishable.
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	PROHIBIT_THUMBNAIL_ONLY Label for the attribute.
private boolean	prohibitThumbnailOnly
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TARGET Label for the attribute.
static String	TARGET_REFERENCE Label for the attribute.
private ObjectReference	targetReference
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

PublishingProhibition()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
RepresentablesAndMasters	getTarget() Gets the object for the association that plays role: TARGET.
ObjectReference	getTargetReference() Gets the value of the attribute: TARGET_REFERENCE.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(RepresentablesAndMasters target, boolean prohibitThumbnailsOnly, String description) Supports initialization, following construction of an instance.
boolean	isProhibitThumbnailOnly() Gets the value of the attribute: PROHIBIT_THUMBNAIL_ONLY.
static PublishingProhibition	newPublishingProhibition(RepresentablesAndMasters target, boolean prohibitThumbnailsOnly, String description) A new-factory method that construct an initialized instance of a WTChangeRequest2 with the given name.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(PublishingProhibition thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setProhibitThumbnailOnly(boolean a_ProhibitThumbnailOnly) Sets the value of the attribute: PROHIBIT_THUMBNAIL_ONLY.
void	setTarget(RepresentablesAndMasters a_Target) Sets the object for the association that plays role: TARGET.
void	setTargetReference(ObjectReference a_TargetReference) Sets the value of the attribute: TARGET_REFERENCE.
private void	targetReferenceValidate(ObjectReference a_TargetReference)
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

PROHIBIT_THUMBNAIL_ONLY

public static final String PROHIBIT_THUMBNAIL_ONLY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

prohibitThumbnailOnly

private boolean prohibitThumbnailOnly

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Describes why the Representable is not publishable. Usually a Representable iteration is not publisheable because of a publishing error, so the description will be an automatically entered description from the publishing process. Usually a Representable master is not publishable because it is so big that it takes too long to publish, so the description might be entered by an administrator.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

TARGET

public static final String TARGET

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

TARGET_REFERENCE

public static final String TARGET_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

targetReference

private ObjectReference targetReference

thePersistInfo

private PersistInfo thePersistInfo

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

PublishingProhibition

public PublishingProhibition()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PublishingProhibition thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

isProhibitThumbnailOnly

public boolean isProhibitThumbnailOnly()

Gets the value of the attribute: PROHIBIT_THUMBNAIL_ONLY.

Supported API: false

Returns:

boolean

setProhibitThumbnailOnly

public void setProhibitThumbnailOnly(boolean a_ProhibitThumbnailOnly)
                              throws WTPropertyVetoException

Sets the value of the attribute: PROHIBIT_THUMBNAIL_ONLY.

Supported API: false

Parameters:

a_ProhibitThumbnailOnly -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Describes why the Representable is not publishable. Usually a Representable iteration is not publisheable because of a publishing error, so the description will be an automatically entered description from the publishing process. Usually a Representable master is not publishable because it is so big that it takes too long to publish, so the description might be entered by an administrator.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. Describes why the Representable is not publishable. Usually a Representable iteration is not publisheable because of a publishing error, so the description will be an automatically entered description from the publishing process. Usually a Representable master is not publishable because it is so big that it takes too long to publish, so the description might be entered by an administrator.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getTarget

public RepresentablesAndMasters getTarget()

Gets the object for the association that plays role: TARGET.

Supported API: false

Returns:

RepresentablesAndMasters

setTarget

public void setTarget(RepresentablesAndMasters a_Target)
               throws WTPropertyVetoException,
                      WTException

Sets the object for the association that plays role: TARGET.

Supported API: false

Parameters:

a_Target -

Throws:

WTPropertyVetoException

WTException

getTargetReference

public ObjectReference getTargetReference()

Gets the value of the attribute: TARGET_REFERENCE.

Supported API: false

Returns:

ObjectReference

setTargetReference

public void setTargetReference(ObjectReference a_TargetReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: TARGET_REFERENCE.

Supported API: false

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

targetReferenceValidate

private void targetReferenceValidate(ObjectReference a_TargetReference)
                              throws WTPropertyVetoException

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

newPublishingProhibition

public static PublishingProhibition newPublishingProhibition(RepresentablesAndMasters target,
                                                             boolean prohibitThumbnailsOnly,
                                                             String description)
                                                      throws WTException

A new-factory method that construct an initialized instance of a WTChangeRequest2 with the given name.

Supported API: false

Parameters:

target - The Persistable that should be prohibited from being published.

prohibitThumbnailsOnly -

description -

Returns:

PublishingProhibition

Throws:

WTException

initialize

protected void initialize(RepresentablesAndMasters target,
                          boolean prohibitThumbnailsOnly,
                          String description)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

target - The Persistable that should be prohibited from being published.

prohibitThumbnailsOnly -

description -

Throws:

WTException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

Gets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

Sets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Returns:

int