Grooper.CMIS.PublishToRepository

Publishes one or more Nodes to one or more Target Grooper Repositories. Publishing an object places a read-only clone of the object in the target repository, and establishes a link between the published object and its clone. Published nodes can be updated or unpublished using the Grooper Root - Publishing tab .


Inherits from: Grooper.MultiUICommand(Of GrooperNode)

Constructors

Signature Description
New ()

Fields

Field Name Field Type Description
ContextInstance As System.Object System.Object
Database As Grooper.GrooperDb Grooper.GrooperDb
ipd As Grooper.IProgressDisplay Grooper.IProgressDisplay
Parent As System.Windows.Forms.IWin32Window System.Windows.Forms.IWin32Window

Properties

Property Name Property Type Description
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
ItemsToPublish Grooper.NodeExportDataCollection The list of items to be Published.
MaintainLink System.Boolean If true, then a link will be maintained in the source repository to each item published to one or more target repositories so it may be republished or unpublished at a later date. Maintaining a link to published items is especially useful for Batch Processes which may be created in one repository by an integrator and then published to one or more target repositories to be used in production. If the Batch Process needs to be modified in the source repository then it can be easily updated to the target repositories it was previously published to. The Grooper Root - Publishing of the root node displays a user interface listing all links to previously published items where they may be republished or unpublished as desired.
PublishAsReadOnly System.Boolean If true, objects will be published as readonly objects.
RepositoryIds System.Collections.Generic.List(Of T) The Grooper repositories to which items should be published. The repositories in this list include Repository Connections defined on the local machine, plus all CMIS Repositories which reference a Grooper repository. If both a direct connection and a CMIS connection exists, the direct connection will be used for data transfer.
Root Grooper.GrooperRoot Returns the root node
ShowEllipses System.Boolean Specifies whether elipses (...) will be shown after the command name on context menus. By default, this property will return true if the command has configurable properties, or if the command has the RequiresUIAttribute applied. Derived classes may override this property to exercise direct control over whether ellipses will be displayed.

Methods

Method Name Description
CanExecute(Items As IEnumerable(Of GrooperNode)) As Boolean
Parameters
Items
          Type: IEnumerable`1
          
CanExecuteCommand(Items As IEnumerable) As Boolean Returns true if the command can be executed on the provided list of items.
Parameters
Items
          Type: IEnumerable
          The list of item to which the command will be applied.
Execute(Items As IEnumerable(Of GrooperNode))
Parameters
Items
          Type: IEnumerable`1
          
ExecuteCommand(Items As IEnumerable) Executes the code written in the overridden instance of ExecuteCommand.
Parameters
Items
          Type: IEnumerable
          A list of items to apply to command to.
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
Initialize(gdb As GrooperDb, Parent As IWin32Window, ContextInstance As Object) Initializes the command.
Parameters
gdb
          Type: GrooperDb
          The Grooper database.
 
Parent
          Type: IWin32Window
          The parent window, or null if there is no UI.
 
ContextInstance
          Type: Object
          An optional context instance.
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
IsValidRepositoryId(Root As GrooperRoot, RepositoryId As Guid) As Boolean
Parameters
Root
          Type: GrooperRoot
          
 
RepositoryId
          Type: Guid
          
OnInitialize(Items As IEnumerable(Of GrooperNode)) As Boolean
Parameters
Items
          Type: IEnumerable`1
          
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
ToString() As String Returns a string value representation of the connected object.
Uninitialize() Uninitializes the command.
ValidateProperties() As ValidationErrorList Perform validation before allowing execution to continue
ValidateRepositories(Root As GrooperRoot, RepositoryIds As List(Of Guid)) As List(Of Guid)
Parameters
Root
          Type: GrooperRoot
          
 
RepositoryIds
          Type: List`1