|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectwt.fc.WTObject
wt.fc.Item
wt.inf.sharing.SharedContainerMap
Records which objects are shared by which containers. Basically it contains references to the shared object and the sharing ("target") container. In case the shared object is foldered, also contains a reference to the folder the shared object is placed in the target container. A SharedContainerMap object is also called a "sharing."
Each sharing holds also additional attributes that helps querying and other operations.
Use the newSharedContainerMap
static factory method(s),
not the SharedContainerMap
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
Field Summary | |
private static String |
CLASSNAME
|
static int |
COLLECTIVE
Supported API: false |
static String |
CONTAINER
Label for the attribute. |
private WTContainerRef |
containerReference
|
static String |
CREATOR_REF
Label for the attribute; Reference to the user who created the sharing. |
private WTPrincipalReference |
creatorRef
|
private boolean |
enabled
|
static String |
ENABLED
Label for the attribute; Determines if the sharing is active. |
private AclEntrySet |
entrySet
|
static long |
EXTERNALIZATION_VERSION_UID
|
static int |
FOLDER
Supported API: false |
static String |
ITERATION_ID
Label for the attribute; Attribute containing the IterationIdentifier
for the first iteration shared, in case the shared object is Iterated . |
private IterationIdentifier |
iterationId
|
protected static long |
OLD_FORMAT_VERSION_UID
|
private static String |
RESOURCE
|
(package private) static long |
serialVersionUID
|
static String |
SHARE_KEY
Label for the attribute; Identification of the sharing. |
static String |
SHARE_TYPE
Label for the attribute. |
static String |
SHARED_OBJECT_REF
Label for the attribute; Reference to the shared object. |
static String |
SHARED_VERSION_REF
Label for the attribute. |
private ObjectReference |
sharedObjectRef
|
private VersionReference |
sharedVersionRef
|
private long |
shareKey
|
private int |
shareType
|
static int |
SINGLE
Supported API: false |
static String |
SOURCE_CONTAINER_REF
Label for the attribute; Reference to the container that ows the shared object. |
private WTContainerRef |
sourceContainerRef
|
static int |
STRUCTURE
Supported API: false |
static String |
TARGET_CONTAINER_REF
Label for the attribute; Reference to the container that is sharing the object. |
static String |
TARGET_FOLDER_REF
Label for the attribute; Folder in the target container where the shared object is located. |
private WTContainerRef |
targetContainerRef
|
private ObjectReference |
targetFolderRef
|
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.access.AdHocControlled |
ENTRY_SET |
Fields inherited from interface wt.fc.Persistable |
IDENTITY, PERSIST_INFO, TYPE |
Fields inherited from interface wt.inf.container.WTContained |
CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE |
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 | |
SharedContainerMap()
|
Method Summary | |
private void |
containerReferenceValidate(WTContainerRef a_ContainerReference)
|
SharedContainerMap |
copy(Persistable object)
Creates a non persistent copy of the object referencing the Persistable object passed as argument in case it is not null. |
boolean |
equals(Object obj)
Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifier s. |
boolean |
equals(SharedContainerMap other)
Supported API: false |
String |
getConceptualClassname()
Deprecated. |
WTContainer |
getContainer()
Gets the object for the association that plays role: CONTAINER. |
String |
getContainerName()
Gets the value of the attribute: CONTAINER_NAME. |
WTContainerRef |
getContainerReference()
Gets the value of the attribute: CONTAINER_REFERENCE. |
WTPrincipalReference |
getCreatorRef()
Gets the value of the attribute: CREATOR_REF. |
AclEntrySet |
getEntrySet()
Gets the value of the attribute: ENTRY_SET. |
private static long |
getId(Object object)
Returns object's id. |
IterationIdentifier |
getIterationId()
Gets the value of the attribute: ITERATION_ID. |
static ObjectIdentifier |
getOid(Object object)
Returns object's associated oid. |
static String |
getOidString(Object obj)
|
Persistable |
getShared()
Returns the target object. |
ObjectReference |
getSharedObjectRef()
Gets the value of the attribute: SHARED_OBJECT_REF. |
VersionReference |
getSharedVersionRef()
Gets the value of the attribute: SHARED_VERSION_REF. |
long |
getShareKey()
Gets the value of the attribute: SHARE_KEY. |
int |
getShareType()
Gets the value of the attribute: SHARE_TYPE. |
WTContainerRef |
getSourceContainerRef()
Gets the value of the attribute: SOURCE_CONTAINER_REF. |
Persistable |
getStructureHandle()
Returns the handle of the structure for the map. |
WTContainerRef |
getTargetContainerRef()
Gets the value of the attribute: TARGET_CONTAINER_REF. |
ObjectReference |
getTargetFolderRef()
Gets the value of the attribute: TARGET_FOLDER_REF. |
int |
hashCode()
Returns a hash code for this object based upon its ObjectIdentifier . |
protected void |
initialize()
Sets the default container and domain. |
boolean |
isEnabled()
Gets the value of the attribute: ENABLED. |
private boolean |
isVersion()
|
boolean |
isVersionShare()
Determines whether the share map corresponds to a version share. |
static SharedContainerMap |
newSharedContainerMap()
Supported API: false |
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(SharedContainerMap thisObject,
ObjectInput input,
long readSerialVersionUID,
boolean passThrough,
boolean superDone)
Reads the non-transient fields of this class from an external source. |
private boolean |
same(Object obj1,
Object obj2)
|
private boolean |
sameEntrySet(AclEntrySet set1,
AclEntrySet set2)
|
private boolean |
sameIterId(IterationIdentifier iter_id1,
IterationIdentifier iter_id2)
|
private boolean |
sameReference(ObjectReference ref1,
ObjectReference ref2)
|
void |
setContainer(WTContainer a_Container)
Sets the object for the association that plays role: CONTAINER. |
void |
setContainerReference(WTContainerRef a_ContainerReference)
Sets the value of the attribute: CONTAINER_REFERENCE. |
void |
setCreatorRef(WTPrincipalReference a_CreatorRef)
Sets the value of the attribute: CREATOR_REF. |
void |
setEnabled(boolean a_Enabled)
Sets the value of the attribute: ENABLED. |
void |
setEntrySet(AclEntrySet a_EntrySet)
Sets the value of the attribute: ENTRY_SET. |
void |
setIterationId(IterationIdentifier a_IterationId)
Sets the value of the attribute: ITERATION_ID. |
void |
setSharedObjectRef(ObjectReference a_SharedObjectRef)
Sets the value of the attribute: SHARED_OBJECT_REF. |
void |
setSharedVersionRef(VersionReference a_SharedVersionRef)
Sets the value of the attribute: SHARED_VERSION_REF. |
void |
setShareKey(long a_ShareKey)
Sets the value of the attribute: SHARE_KEY. |
void |
setShareType(int a_ShareType)
Sets the value of the attribute: SHARE_TYPE. |
void |
setSourceContainerRef(WTContainerRef a_SourceContainerRef)
Sets the value of the attribute: SOURCE_CONTAINER_REF. |
void |
setTargetContainerRef(WTContainerRef a_TargetContainerRef)
Sets the value of the attribute: TARGET_CONTAINER_REF. |
void |
setTargetFolderRef(ObjectReference a_TargetFolderRef)
Sets the value of the attribute: TARGET_FOLDER_REF. |
String |
toString()
Creates and returns String representation of the map. |
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.NetFactor |
getClassInfo |
Methods inherited from interface wt.fc.Persistable |
checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo |
Field Detail |
private static final String RESOURCE
private static final String CLASSNAME
public static final String SHARED_OBJECT_REF
WTReference
,
ObjectReference
,
VersionReference
,
Constant Field Valuesprivate ObjectReference sharedObjectRef
public static final String SHARED_VERSION_REF
private VersionReference sharedVersionRef
public static final String ITERATION_ID
IterationIdentifier
for the first iteration shared, in case the shared object is Iterated
.
If the object is not iterated, this attribute is null.
private IterationIdentifier iterationId
public static final String TARGET_CONTAINER_REF
private WTContainerRef targetContainerRef
public static final String SOURCE_CONTAINER_REF
private WTContainerRef sourceContainerRef
public static final String TARGET_FOLDER_REF
private ObjectReference targetFolderRef
public static final String CREATOR_REF
private WTPrincipalReference creatorRef
public static final String ENABLED
private boolean enabled
public static final String SHARE_KEY
Shared object collections can result from sharing a complex object like a folder or a part or through multiple select. In these cases it might be desirable to cancel the share to all objects of the share. The information about the set is held in the key attribute.
Note: the shared object key is not enough to characterize the collective
share operation but the pair This attribute is modeled as a String so not to constrain what can
be stored in it. For cases where it is possible to identify a single
object to represent the collection (such as a folder), a possibility
is to use a stringfied representation of the object's reference.
Supported API: false
private long shareKey
public static final String SHARE_TYPE
private int shareType
public static final int SINGLE
public static final int COLLECTIVE
public static final int FOLDER
public static final int STRUCTURE
private AclEntrySet entrySet
public static final String CONTAINER
private WTContainerRef containerReference
static final long serialVersionUID
public static final long EXTERNALIZATION_VERSION_UID
protected static final long OLD_FORMAT_VERSION_UID
Constructor Detail |
public SharedContainerMap()
Method Detail |
public void writeExternal(ObjectOutput output) throws IOException
writeExternal
in interface Externalizable
writeExternal
in class Item
output
-
IOException
public void readExternal(ObjectInput input) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
readExternal
in class Item
input
-
IOException
ClassNotFoundException
protected boolean readVersion(SharedContainerMap thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
thisObject
- input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
private boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) throws IOException, ClassNotFoundException
input
- readSerialVersionUID
- passThrough
- superDone
-
IOException
ClassNotFoundException
public void writeExternal(PersistentStoreIfc output) throws SQLException, DatastoreException
(Not intended for general use.)
Supported API: false
writeExternal
in interface ObjectMappable
writeExternal
in class Item
output
-
SQLException
DatastoreException
public void readExternal(PersistentRetrieveIfc input) throws SQLException, DatastoreException
(Not intended for general
use.)
Supported API: false
readExternal
in interface ObjectMappable
readExternal
in class Item
input
-
SQLException
DatastoreException
public String getConceptualClassname()
getConceptualClassname
in interface NetFactor
public ObjectReference getSharedObjectRef()
WTReference
,
ObjectReference
,
VersionReference
public void setSharedObjectRef(ObjectReference a_SharedObjectRef)
a_SharedObjectRef
- WTReference
,
ObjectReference
,
VersionReference
public VersionReference getSharedVersionRef()
public void setSharedVersionRef(VersionReference a_SharedVersionRef)
a_SharedVersionRef
- public IterationIdentifier getIterationId()
IterationIdentifier
for the
first iteration shared, in case the shared object is Iterated
.
If the object is not iterated, this attribute is null.
public void setIterationId(IterationIdentifier a_IterationId)
IterationIdentifier
for the
first iteration shared, in case the shared object is Iterated
.
If the object is not iterated, this attribute is null.
a_IterationId
- public WTContainerRef getTargetContainerRef()
public void setTargetContainerRef(WTContainerRef a_TargetContainerRef)
a_TargetContainerRef
- public WTContainerRef getSourceContainerRef()
public void setSourceContainerRef(WTContainerRef a_SourceContainerRef)
a_SourceContainerRef
- public ObjectReference getTargetFolderRef()
public void setTargetFolderRef(ObjectReference a_TargetFolderRef)
a_TargetFolderRef
- public WTPrincipalReference getCreatorRef()
public void setCreatorRef(WTPrincipalReference a_CreatorRef)
a_CreatorRef
- public boolean isEnabled()
public void setEnabled(boolean a_Enabled)
a_Enabled
- public long getShareKey()
Shared object collections can result from sharing a complex object like a folder or a part or through multiple select. In these cases it might be desirable to cancel the share to all objects of the share. The information about the set is held in the key attribute.
Note: the shared object key is not enough to characterize the
collective share operation but the pair This attribute is modeled as a String so not to constrain what
can be stored in it. For cases where it is possible to identify a
single object to represent the collection (such as a folder), a possibility
is to use a stringfied representation of the object's reference.
Supported API: false
public void setShareKey(long a_ShareKey)
Shared object collections can result from sharing a complex object like a folder or a part or through multiple select. In these cases it might be desirable to cancel the share to all objects of the share. The information about the set is held in the key attribute.
Note: the shared object key is not enough to characterize the
collective share operation but the pair This attribute is modeled as a String so not to constrain what
can be stored in it. For cases where it is possible to identify a
single object to represent the collection (such as a folder), a possibility
is to use a stringfied representation of the object's reference.
Supported API: false
a_ShareKey
-
public int getShareType()
public void setShareType(int a_ShareType)
a_ShareType
- public Persistable getShared()
public String toString()
toString
in class WTObject
public static SharedContainerMap newSharedContainerMap() throws WTException
WTException
public SharedContainerMap copy(Persistable object) throws WTException
Persistable
object passed as argument in case it is not null.
Otherwise the referenced object is the same as the original map.
object
-
WTException
public Persistable getStructureHandle() throws WTException
WTException
public boolean isVersionShare()
public boolean equals(SharedContainerMap other)
other
-
protected void initialize() throws WTException
initialize
in class Item
WTException
public AclEntrySet getEntrySet()
getEntrySet
in interface AdHocControlled
public void setEntrySet(AclEntrySet a_EntrySet)
setEntrySet
in interface AdHocControlled
a_EntrySet
- public String getContainerName()
WTContainer
this object is assigned to.
getContainerName
in interface WTContained
public WTContainer getContainer()
getContainer
in interface WTContained
public void setContainer(WTContainer a_Container) throws WTPropertyVetoException, WTException
setContainer
in interface WTContained
a_Container
-
WTPropertyVetoException
WTException
public WTContainerRef getContainerReference()
getContainerReference
in interface WTContained
public void setContainerReference(WTContainerRef a_ContainerReference) throws WTPropertyVetoException
setContainerReference
in interface WTContained
a_ContainerReference
-
WTPropertyVetoException
private void containerReferenceValidate(WTContainerRef a_ContainerReference) throws WTPropertyVetoException
a_ContainerReference
-
WTPropertyVetoException
public boolean equals(Object obj)
ObjectIdentifier
s.
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
equals
in class Item
obj
-
public int hashCode()
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
hashCode
in class Item
private boolean isVersion()
public static ObjectIdentifier getOid(Object object)
private static long getId(Object object)
public static String getOidString(Object obj)
private boolean same(Object obj1, Object obj2)
private boolean sameReference(ObjectReference ref1, ObjectReference ref2)
private boolean sameIterId(IterationIdentifier iter_id1, IterationIdentifier iter_id2)
private boolean sameEntrySet(AclEntrySet set1, AclEntrySet set2)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |