BCWorkPackage Class

BCWorkPackage Class

Represents a work area in the vault.

Inheritance Hierarchy

SystemObject
  BlueCieloECM.InnoCielo.MeridianDisposableObject
    BlueCieloECM.InnoCielo.Meridian.ServerBCRepositoryObject
      BlueCieloECM.InnoCielo.Meridian.ServerBCWorkPackage

Namespace: BlueCieloECM.InnoCielo.Meridian.Server
Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.19.0)

Syntax

C++

Copy

public class BCWorkPackage : BCRepositoryObject

Public Class BCWorkPackage
	Inherits BCRepositoryObject

public ref class BCWorkPackage : public BCRepositoryObject

type BCWorkPackage =  
    class
        inherit BCRepositoryObject
    end

The BCWorkPackage type exposes the following members.

Properties

	Name	Description
	AccessRights	Gets access rights of the work area.
	Baselines	Gets the collection of baselines created in the work area.
	ColumnPropertyDefCollection	Gets the collection of the properties that are shown as columns in "All Documents in the work area" view.
	CreatedFrom	Gets the template that the work area was created from. Returns for the Main area.
	CreationDate	Gets the date the work area was created.
	CurrentState	Gets the current transition state of the work area.
	DisplayName	Gets or sets the display name of the work area.
	Enclosure	Gets the enclosure that manages access to dependent objects.
	Extendable	Gets the extended object. (Inherited from BCRepositoryObject.)
	ID	Gets the value that uniquely identifies the work area.
	IsDisposed	Gets a value indicating whether the object has been disposed of. (Inherited from DisposableObject.)
	MaintainHistory	Gets or sets a value indicating whether a history is kept during the lifetime of the work area.
	Name	Gets the internal name of the work area.
	OnImportDocument	Gets or sets the state to set when a document is imported.
	ParentWorkPackage	Gets the parent work area. Returns for main area.
	Path	Gets the context path of the work area. Lists all parent work areas separated by backslashes (\).
	Repository	Gets the repository to which the object belongs. (Inherited from BCRepositoryObject.)
	RetainHistory	Gets a value indicating whether the full history is retained after the work area has become inactive.
	Securable	Gets the secured object. (Inherited from BCRepositoryObject.)
	Selections	Gets the collection of selections in the current work area.
	SubWorkPackages	Gets the collection of sub-work areas in the work area.
	Template	Gets the template used to create the work package.
	UnderlyingObject	Gets the underlying wrapped object. (Inherited from DisposableObject.)
	WorkIsolationMode	Gets or sets a value indicating whether Work Isolation mode has been enabled for the work area.
	WorkLists	Gets the collection of work lists in the work area.

Top

Methods

	Name	Description
	AddDocument	Assigns a document to the work area.
	Dispose	Releases the underlying wrapped object explicitly. (Inherited from DisposableObject.)
	Documents	Returns the collection of documents assigned to the work area. The collection is sorted ascending on the DisplayName property value.
	Documents(BCCollectionBaseBCPropertyDef)	Returns the collection of documents assigned to the work area. The collection is sorted ascending on the DisplayName property value.
	Documents(BCCollectionBaseBCPropertyDef, SortKind)	Returns the collection of documents assigned to the work area.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExecuteTransition(BCWorkPackageTransition)	Moves the work area to another state.
	ExecuteTransition(BCWorkPackageTransition, BCBaseline, BCBaseline)	Moves the work area to another state.
	ExecuteTransition(BCWorkPackageTransition, BCBaseline, BCBaseline, Boolean)	Moves the work area to another state.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetBaseline	Returns a baselines with the specified ID property value created in the work area.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetSelection	Returns a selection with the specified ID property value.
	GetSequence	Returns a sequence with the specified name. If the sequence does not exist, creates it. (Inherited from BCRepositoryObject.)
	GetSequenceList	Returns an array of all available sequences. (Inherited from BCRepositoryObject.)
	GetSubWorkPackage	Returns a sub-work area with the specified ID property value.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWorkList	Returns a work list in the work area with the specified ID property value.
	LoadProperties	Returns a property collection for a property set with the specified name. (Inherited from BCRepositoryObject.)
	MakeSelection	Returns a new selection object from the given collection of documents.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NewBaseline	Creates a new baseline.
	NewSelection	Creates a new selection.
	NewSubWorkPackage	Creates a new sub-work area.
	OnDispose	The method is called on the Dispose method call. Derived classes should override the method to perform custom disposing. (Inherited from DisposableObject.)
	ReleaseDocument(BCDocument)	Releases a document to the parent area with no reassignment.
	ReleaseDocument(BCDocument, Boolean)	Releases a document to the parent area.
	RemoveDocument(BCDocument)	Discards/revokes a document from the work area with no reassignment.
	RemoveDocument(BCDocument, Boolean)	Discards/revokes a document from the work area.
	RemoveSubWorkPackage	Removes the given sub-work area.
	SaveProperties	Saves a property collection. (Inherited from BCRepositoryObject.)
	ThrowIfDisposed	Throws the ObjectDisposedException exception if the underlying object has been disposed. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

BlueCieloECM.InnoCielo.Meridian.Server Namespace