IState Interface |
State base interface.
Namespace: PDTec.IceNet.Domain.Lifecycle.BusinessObjects
Assembly: PDTec.IceNet.Domain (in PDTec.IceNet.Domain.dll) Version: 7.2.0.0 (7.2.7583.15464)
SyntaxC#
public interface IState : IStateBase, IObject
The IState type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ChangedBy |
Gets the name of the user who changed the object last.
(Inherited from IObject.) |
| ChangedOn |
Gets the point of time the object was changed last.
(Inherited from IObject.) |
| CreatedBy |
Gets the name of the user who created the object.
(Inherited from IObject.) |
| CreatedOn |
Gets the point of time the object was created.
(Inherited from IObject.) |
| Description |
Gets or sets the object description. The description can be empty.
(Inherited from IObject.) |
| Folder |
Gets the containing folder.
(Inherited from IObject.) |
| Id |
Gets the object ID. The ID is generated by the platform and
cannot be modified.
(Inherited from IObject.) |
| IsLocked |
Indicates if the object is locked.
(Inherited from IObject.) |
| IsReferenced | |
| IsValid |
Indicates if the object instance is valid. The object becomes
invalid if the Destroy method has been called.
(Inherited from IObject.) |
| LifecycleableStateReverse |
Gets the collection of Lifecycleable objects connected by a State relationship in Reverse direction.
(Inherited from IStateBase.) |
| LifecycleStatesReverse |
Gets or sets the Lifecycle connected by a States relationship in Reverse direction.
(Inherited from IStateBase.) |
| LockedBy |
Gets the name of the user who holds a lock on the object, empty
string if the object is not locked.
(Inherited from IObject.) |
| LockedOn |
Gets the lock timestamp, if object is locked. DateTime.MinValue if not.
(Inherited from IObject.) |
| Name |
Gets or sets the object name. The name cannot be an empty string. It is
modifiable and does not have to be unique.
(Inherited from IObject.) |
| ObjType |
Gets the object type.
(Inherited from IObject.) |
| StateEnterActions |
Gets the collection of Lifecycle Action objects connected by a Enter Actions relationship in Forward direction.
(Inherited from IStateBase.) |
| TransitionFromStateReverse |
Gets the collection of Transition objects connected by a From State relationship in Reverse direction.
(Inherited from IStateBase.) |
| TransitionToStateReverse |
Gets the collection of Transition objects connected by a To State relationship in Reverse direction.
(Inherited from IStateBase.) |
Methods| Name | Description | |
|---|---|---|
 | AddKey |
Adds a new key to the object. The key must be unique
within the system context (e.g. unique per database).
(Inherited from IObject.) |
| AddLifecycleableStateReverse |
Adds pItem to the collection of Lifecycleable objects connected by State relationships in Reverse direction.
(Inherited from IStateBase.) |
| AddStateEnterActions |
Adds pItem to the collection of Lifecycle Action objects connected by Enter Actions relationships in Forward direction.
(Inherited from IStateBase.) |
| AddTransitionFromStateReverse |
Adds pItem to the collection of Transition objects connected by From State relationships in Reverse direction.
(Inherited from IStateBase.) |
| AddTransitionToStateReverse |
Adds pItem to the collection of Transition objects connected by To State relationships in Reverse direction.
(Inherited from IStateBase.) |
| AsT | Obsolete.
Casts to a Business Object interface.
(Inherited from IObject.) |
| CastT |
Casts to a Business Object interface. Throws an exception if the Business Object
interface is not available for this object.
(Inherited from IObject.) |
| ChangeObjType |
Change the object type.
(Inherited from IObject.) |
| ClearLifecycleableStateReverse |
Clears the collection of Lifecycleable objects connected by State relationships in Reverse direction.
(Inherited from IStateBase.) |
| ClearStateEnterActions |
Clears the collection of Lifecycle Action objects connected by Enter Actions relationships in Forward direction.
(Inherited from IStateBase.) |
| ClearTransitionFromStateReverse |
Clears the collection of Transition objects connected by From State relationships in Reverse direction.
(Inherited from IStateBase.) |
| ClearTransitionToStateReverse |
Clears the collection of Transition objects connected by To State relationships in Reverse direction.
(Inherited from IStateBase.) |
| ContainsLifecycleableStateReverse |
Determines whether pItem is contained in the collection of Lifecycleable objects connected by State relationships in Reverse direction.
(Inherited from IStateBase.) |
| ContainsStateEnterActions |
Determines whether pItem is contained in the collection of Lifecycle Action objects connected by Enter Actions relationships in Forward direction.
(Inherited from IStateBase.) |
| ContainsTransitionFromStateReverse |
Determines whether pItem is contained in the collection of Transition objects connected by From State relationships in Reverse direction.
(Inherited from IStateBase.) |
| ContainsTransitionToStateReverse |
Determines whether pItem is contained in the collection of Transition objects connected by To State relationships in Reverse direction.
(Inherited from IStateBase.) |
| CopyTo |
Copies the object. Attributes of the object are copied, relationships not.
(Inherited from IObject.) |
| CreateTransition | |
| DeleteKey |
Removes a key from the object.
(Inherited from IObject.) |
| DeleteState | |
| Destroy |
Deletes the object (and its relationships).
(Inherited from IObject.) |
| GetAttributes |
Gets all attributes of the State.
(Inherited from IStateBase.) |
| GetAttrValue(IAttrDef) |
Retrieves the specified attribute value.
(Inherited from IObject.) |
| GetAttrValue(String, String) |
Retrieves the specified attribute value.
(Inherited from IObject.) |
| GetAttrValue(IAttrDef, Boolean) | Obsolete.
Retrieves the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| GetAttrValue(String, String, Boolean) | Obsolete.
Retrieves the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| GetAttrValues |
Get all attribute values of the object.
(Inherited from IObject.) |
| GetFolder |
Retrieves the object's folder.
(Inherited from IObject.) |
| GetKeys |
Retrieves the object's (unique) keys.
(Inherited from IObject.) |
| GetLockInfo |
Retrieves information about the object's lock status.
(Inherited from IObject.) |
| GetObjType |
Retrieve the object type.
(Inherited from IObject.) |
| GetPromoteableStates | |
| GetRelationships(RelDirection) |
Retrieves all attached relationships of a specific direction (regardless of their relationship type).
(Inherited from IObject.) |
| GetRelationships(String, RelDirection) |
Retrieves all attached relationships of a specific role (relationship type/direction combination).
(Inherited from IObject.) |
| GetRelationships(IRelType, RelDirection) |
Retrieves all attached relationships of a specific relationship type in a
specific direction.
(Inherited from IObject.) |
| GetSingleRelationship(String, RelDirection) |
Retrieves a single relationship (omit the array overhead).
(Inherited from IObject.) |
| GetSingleRelationship(IRelType, RelDirection) |
Retrieves a single relationship (omit the array overhead).
(Inherited from IObject.) |
| GetTableAttrTemplateRow |
Gets a table attribute template row.
(Inherited from IObject.) |
| GetTableAttrValues |
Gets the table attribute values.
(Inherited from IObject.) |
| InsertStateEnterActions |
Inserts pItem into the collection of Lifecycle Action objects connected by Enter Actions relationships in Forward direction.
(Inherited from IStateBase.) |
| IsOf(String) |
Indicates if the object conforms to a specific object type directly
or indirectly (is a subtype of).
(Inherited from IObject.) |
| IsOf(IObjType) |
Indicates if the object conforms to a specific object type directly
or indirectly (is a subtype of).
(Inherited from IObject.) |
| Lock |
Lock the object.
(Inherited from IObject.) |
| MoveTo |
Moves the object to another folder.
(Inherited from IObject.) |
| QueryInterface |
Cast to a Business Object interface.
(Inherited from IObject.) |
| Reload |
Refreshes the object data from secondary storage (e.g. database)
if available. Use this method to retrieve up-to-date audit information
(ChangedBy, ChangedOn properties).
(Inherited from IObject.) |
| RemoveLifecycleableStateReverse |
Removes pItem from the collection of Lifecycleable objects connected by State relationships in Reverse direction.
(Inherited from IStateBase.) |
| RemoveStateEnterActions |
Removes pItem from the collection of Lifecycle Action objects connected by Enter Actions relationships in Forward direction.
(Inherited from IStateBase.) |
| RemoveTransitionFromStateReverse |
Removes pItem from the collection of Transition objects connected by From State relationships in Reverse direction.
(Inherited from IStateBase.) |
| RemoveTransitionToStateReverse |
Removes pItem from the collection of Transition objects connected by To State relationships in Reverse direction.
(Inherited from IStateBase.) |
| SetAttributes |
Sets all attributes of the State.
(Inherited from IStateBase.) |
| SetAttrValue(IAttrDef, Object) |
Stores the specified attribute value.
(Inherited from IObject.) |
| SetAttrValue(String, String, Object) |
Stores the specified attribute value.
(Inherited from IObject.) |
| SetAttrValues |
Set multiple attribute values with a single method call.
(Inherited from IObject.) |
| SetRelationshipIndex |
Re-position a relationship within the object/reltype/direction order.
(Inherited from IObject.) |
| SetRelationshipIndices |
Re-order all relationships of a object/reltype/direction context.
(Inherited from IObject.) |
| SetTableAttrValues |
Sets the table attribute values.
(Inherited from IObject.) |
| Touch |
Updates the ChangedBy and ChangedOn information.
(Inherited from IObject.) |
| TryCastT |
Casts to a Business Object interface.
(Inherited from IObject.) |
| TryGetAttrValue(IAttrDef, Boolean) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(IAttrDef, DateTime) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(IAttrDef, Double) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(IAttrDef, Int64) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(IAttrDef, Object) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(IAttrDef, String) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(String, String, Boolean) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(String, String, DateTime) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(String, String, Double) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(String, String, Int64) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(String, String, Object) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetAttrValue(String, String, String) |
Attempts to get the specified attribute value and indicates if the value is assigned.
(Inherited from IObject.) |
| TryGetLifecycleStatesReverse |
Tries to get the Lifecycle connected by a States relationship in Reverse direction.
(Inherited from IStateBase.) |
| TryGetSingleRelationship(String, RelDirection, IRelationship) |
Tries to retrieves a single relationship.
(Inherited from IObject.) |
| TryGetSingleRelationship(IRelType, RelDirection, IRelationship) |
Tries to retrieves a single relationship.
(Inherited from IObject.) |
| UnLock |
Unlock the object.
(Inherited from IObject.) |
Extension Methods| Name | Description | |
|---|---|---|
 | GetFolderId |
Gets the folder ID without unneccessarily retrieving the full folder information.
(Defined by ModelExtensions.) |
| GetRepository |
Gets the corresponding repository for an object.
(Defined by ModelExtensions.) |
| IsConnected(String, RelDirection) | Overloaded.
Detects whether an object is connected by at least one relationship of a specific type.
(Defined by ModelExtensions.) |
| IsConnected(IRelType, RelDirection) | Overloaded.
Detects whether an object is connected by at least one relationship of a specific type.
(Defined by ModelExtensions.) |
See Also