wt.audit.eventinfo
Class NotAuthorizedEventInfo

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.fc.Item
          extended bywt.audit.eventinfo.NotAuthorizedEventInfo
All Implemented Interfaces:
AccessControlled, DisplayIdentification, DomainAdministered, EventInfo, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class NotAuthorizedEventInfo
extends Item
implements EventInfo, Externalizable

Use the newNotAuthorizedEventInfo static factory method(s), not the NotAuthorizedEventInfo 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
           
static String EVENT
          Label for the attribute.
private  ObjectReference eventReference
           
static long EXTERNALIZATION_VERSION_UID
           
private  String message
           
static String MESSAGE
          Label for the attribute; Exception message for the not authorized exception event.
private static int MESSAGE_UPPER_LIMIT
           
protected static long OLD_FORMAT_VERSION_UID
           
private  String permission
           
static String PERMISSION
          Label for the attribute; Permission that was not granted and resulted in the exception.
static String PERMISSION_MASK
          Label for the attribute.
private static int PERMISSION_UPPER_LIMIT
           
private  long permissionMask
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.fc.Item
VERSION_40_UID, VERSION_51_UID
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.audit.eventinfo.EventInfo
EVENT_REFERENCE
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Fields inherited from interface wt.admin.DomainAdministered
DOMAIN_REF, INHERITED_DOMAIN
 
Fields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
NotAuthorizedEventInfo()
           
 
Method Summary
 boolean equals(Object obj)
          Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private  void eventReferenceValidate(ObjectReference a_EventReference)
           
 String getConceptualClassname()
          Deprecated.  
 ProjectAuditEvent getEvent()
          Gets the object for the association that plays role: EVENT.
 ObjectReference getEventReference()
          Gets the value of the attribute: EVENT_REFERENCE.
 String getIdString(ObjectReference ref)
           
 String getMessage()
          Gets the value of the attribute: MESSAGE.
 String getPermission()
          Gets the value of the attribute: PERMISSION.
 long getPermissionMask()
          Gets the value of the attribute: PERMISSION_MASK.
 String getString(Object obj)
           
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize()
          

Supported API: false
private  void messageValidate(String a_Message)
           
static NotAuthorizedEventInfo newNotAuthorizedEventInfo()
          Default factory for the class.
 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(NotAuthorizedEventInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setEvent(ProjectAuditEvent a_Event)
          Sets the object for the association that plays role: EVENT.
 void setEventReference(ObjectReference a_EventReference)
          Sets the value of the attribute: EVENT_REFERENCE.
 void setMessage(String a_Message)
          Sets the value of the attribute: MESSAGE.
 void setPermission(String a_Permission)
          Sets the value of the attribute: PERMISSION.
 void setPermissionMask(long a_PermissionMask)
          Sets the value of the attribute: PERMISSION_MASK.
 String toString()
          

Supported API: false
 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 wt.fc.Item
getDomainRef, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain
 
Methods inherited from class wt.fc.WTObject
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface wt.fc.Persistable
checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo
 
Methods inherited from interface wt.fc.NetFactor
getClassInfo
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

PERMISSION

public static final String PERMISSION
Label for the attribute; Permission that was not granted and resulted in the exception.

Supported API: false

See Also:
Constant Field Values

PERMISSION_UPPER_LIMIT

private static int PERMISSION_UPPER_LIMIT

permission

private String permission

MESSAGE

public static final String MESSAGE
Label for the attribute; Exception message for the not authorized exception event.

Supported API: false

See Also:
Constant Field Values

MESSAGE_UPPER_LIMIT

private static int MESSAGE_UPPER_LIMIT

message

private String message

PERMISSION_MASK

public static final String PERMISSION_MASK
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

permissionMask

private long permissionMask

EVENT

public static final String EVENT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

eventReference

private ObjectReference eventReference

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

NotAuthorizedEventInfo

public NotAuthorizedEventInfo()
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
Overrides:
writeExternal in class Item
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
Overrides:
readExternal in class Item
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(NotAuthorizedEventInfo 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
Overrides:
writeExternal in class Item
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
Overrides:
readExternal in class Item
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

getPermission

public String getPermission()
Gets the value of the attribute: PERMISSION. Permission that was not granted and resulted in the exception.

Supported API: false

Returns:
String

setPermission

public void setPermission(String a_Permission)
Sets the value of the attribute: PERMISSION. Permission that was not granted and resulted in the exception.

Supported API: false

Parameters:
a_Permission -

getMessage

public String getMessage()
Gets the value of the attribute: MESSAGE. Exception message for the not authorized exception event.

Supported API: false

Returns:
String

setMessage

public void setMessage(String a_Message)
                throws WTPropertyVetoException
Sets the value of the attribute: MESSAGE. Exception message for the not authorized exception event.

Supported API: false

Parameters:
a_Message -
Throws:
WTPropertyVetoException

messageValidate

private void messageValidate(String a_Message)
                      throws WTPropertyVetoException
Parameters:
a_Message -
Throws:
WTPropertyVetoException

getPermissionMask

public long getPermissionMask()
Gets the value of the attribute: PERMISSION_MASK.

Supported API: false

Returns:
long

setPermissionMask

public void setPermissionMask(long a_PermissionMask)
                       throws WTPropertyVetoException
Sets the value of the attribute: PERMISSION_MASK.

Supported API: false

Parameters:
a_PermissionMask -
Throws:
WTPropertyVetoException

toString

public String toString()


Supported API: false

Overrides:
toString in class WTObject
Returns:
String

newNotAuthorizedEventInfo

public static NotAuthorizedEventInfo newNotAuthorizedEventInfo()
                                                        throws WTException
Default factory for the class.

Supported API: false

Returns:
NotAuthorizedEventInfo
Throws:
WTException

getEvent

public ProjectAuditEvent getEvent()
Gets the object for the association that plays role: EVENT.

Supported API: false

Specified by:
getEvent in interface EventInfo
Returns:
ProjectAuditEvent

setEvent

public void setEvent(ProjectAuditEvent a_Event)
              throws WTPropertyVetoException,
                     WTException
Sets the object for the association that plays role: EVENT.

Supported API: false

Specified by:
setEvent in interface EventInfo
Parameters:
a_Event -
Throws:
WTPropertyVetoException
WTException

getEventReference

public ObjectReference getEventReference()
Gets the value of the attribute: EVENT_REFERENCE.

Supported API: false

Specified by:
getEventReference in interface EventInfo
Returns:
ObjectReference

setEventReference

public void setEventReference(ObjectReference a_EventReference)
                       throws WTPropertyVetoException
Sets the value of the attribute: EVENT_REFERENCE.

Supported API: false

Specified by:
setEventReference in interface EventInfo
Parameters:
a_EventReference -
Throws:
WTPropertyVetoException

eventReferenceValidate

private void eventReferenceValidate(ObjectReference a_EventReference)
                             throws WTPropertyVetoException
Parameters:
a_EventReference -
Throws:
WTPropertyVetoException

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

Overrides:
equals in class Item
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

Overrides:
hashCode in class Item
Returns:
int

initialize

protected void initialize()
                   throws WTException
Description copied from class: Item


Supported API: false

Overrides:
initialize in class Item
Throws:
WTException

getIdString

public String getIdString(ObjectReference ref)

getString

public String getString(Object obj)