IWorldViewSettings Interface

Represents the Worldview Settings

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492

Syntax

public interface IWorldViewSettings : IEntity<ISite>, 
	IEntity, IEntityEvents

Public Interface IWorldViewSettings
	Inherits IEntity(Of ISite), IEntity, IEntityEvents

public interface class IWorldViewSettings : IEntity<ISite^>, 
	IEntity, IEntityEvents

type IWorldViewSettings = 
    interface
        interface IEntity<ISite>
        interface IEntity
        interface IEntityEvents
    end

The IWorldViewSettings type exposes the following members.

Properties

	Name	Description
	Archived	Gets/sets the archived value of this entity (Inherited from IEntity)
	Created	Gets the entity's creation date. (Inherited from IEntity)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity)
	LastModified	Gets the date when the entity was most recently modified. (Inherited from IEntity)
	LastModifiedUser	Gets the ID of the User who lasted edited the entity. (Inherited from IEntity)
	Manager	Gets the manager that retrieved this entity instance. (Inherited from IEntityTManager)
	Session	Gets the session that retrieved this entity. An entity is always session-specific. (Inherited from IEntity)
	SessionId	Gets the unique ID of the session that retrieved this entity. (Inherited from IEntity)

Methods

	Name	Description
	GetIDForWorkflowDefinition	Gets the ID for a workflow definition
	GetIDForWorkState	Gets the ID for a work state
	GetNameForWorkflowDefinition	Gets the name for a workflow definition.
	GetNameForWorkState	Gets the name for a work state.
	SetIDForWorkflowDefinition	Sets the ID for a workflow definition.
	SetIDForWorkState	Sets the ID for a work state.
	Touch	Updated the entity's LastModified value to the current time. (Inherited from IEntity)
	ValidateData	Validates this entity's data. Implemented by concrete inheriting types. (Inherited from IEntity)
	ValidateUserPermission	Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity. (Inherited from IEntity)
	WorkflowDefinitions	Gets the workflow definitions for WorldView
	WorkflowDefinitionsCount	Gets count of workflow definitions
	WorkStates	Gets the work states for WorldView
	WorkStatesCount	Gets the count of the work states

Events

	Name	Description
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents)
	BeforeEntitySave	This event is fired before any Entity object is about to be saved. (Inherited from IEntityEvents)

Remarks

Contains endpoints for getting and setting Worldview Workflow Definitions and Work States.