Inheritance diagram for erminas.SmartAPI.CMS.Project.IProject:

Collaboration diagram for erminas.SmartAPI.CMS.Project.IProject:

Public Member Functions
void	ClearPageCache ()

IProjectCopyJob	CreateCopyJob (string newProjectName)

IProjectExportJob	CreateExportJob (string targetPath)

void	DeleteWithDatabase (string databaseUser, string password)
	Delete this project and its database on the database server

XmlDocument	ExecuteRQL (string query, RqlType type=RqlType.SessionKeyInIodata)
	Execute an rql query.

string	GetTextContent (Guid textElementGuid, ILanguageVariant lang, string typeString)
	CMS.Session.GetTextContent

IProject	Refreshed ()

void	Select ()
	Select this project as active project in the current session.

void	SetLockLevel (ProjectLockLevel level, string infoMessage)
	Set the project lock. The info message must not be empty, if lock level is different than ProjectLockLevel.None!

Guid	SetTextContent (Guid textElementGuid, ILanguageVariant languageVariant, string typeString, string content)
	CMS.Session.SetTextContent

Public Member Functions inherited from erminas.SmartAPI.CMS.IPartialRedDotObject
void	EnsureInitialization ()

void	Refresh ()

Properties
IProjectGroups	AssignedGroups `[get]`

ICategories	Categories `[get]`

IProjectClipboard	Clipboard `[get]`

IContentClasses	ContentClasses `[get]`

IContentClassFolders	ContentClassFolders `[get]`
	All content class folders, indexed by name. The list is cached by default.

IDatabaseConnections	DatabaseConnections `[get]`
	All database connections, indexed by name. The list is cached by default.

IFolders	Folders `[get]`
	All folders, indexed by name. The list is cached by default.

IIndexedCachedList< int, IInfoAttribute >	InfoAttributes `[get]`
	All info attributes in the project, indexed by id. The list is cached by default.

bool	IsArchivingActive `[get]`

bool	IsLockedBySystem `[get]`

bool	IsVersioningActive `[get, set]`

IRDList< IKeyword >	Keywords `[get]`
	All keywords. The list is cached by default.

ILanguageVariants	LanguageVariants `[get]`
	All language variants, indexed by Language. The list is cached by default.

ProjectLockLevel	LockLevel `[get]`
	The project lock level.

IIndexedRDList< string, IUser >	OnlineUsers `[get]`
	Get users currently logged into this project Requires you to have ServerManager rights.

IPages	Pages `[get]`

IProjectVariants	ProjectVariants `[get]`
	All project variants, indexed by name. The list is cached by default.

IRDList< IPublicationFolder >	PublicationFolders `[get]`
	All publication folders

IRDList< IPublicationPackage >	PublicationPackages `[get]`
	All publication packages

IRDList< IPublicationTarget >	PublicationTargets `[get]`
	All publication targets

IRecycleBin	RecycleBin `[get]`

ISyllables	Syllables `[get]`
	All Syllables, indexed by guid. The list is cached by default.

IProjectUsers	Users `[get]`
	All users of the project and their access levels, indexed by user name. The list is cached by default.

IProjectWorkflows	Workflows `[get]`

Properties inherited from erminas.SmartAPI.CMS.ISessionObject
ISession	Session `[get]`

Detailed Description

Definition at line 104 of file IProject.cs.

Member Function Documentation

void erminas.SmartAPI.CMS.Project.IProject.ClearPageCache ( )

IProjectCopyJob erminas.SmartAPI.CMS.Project.IProject.CreateCopyJob ( string newProjectName )

IProjectExportJob erminas.SmartAPI.CMS.Project.IProject.CreateExportJob ( string targetPath )

void erminas.SmartAPI.CMS.Project.IProject.DeleteWithDatabase	(	string	databaseUser,
		string	password
	)

Delete this project and its database on the database server

XmlDocument erminas.SmartAPI.CMS.Project.IProject.ExecuteRQL	(	string	query,
		RqlType	type = `RqlType.SessionKeyInIodata`
	)

Execute an rql query.

Parameters

query	The query string (not containing IODATA/PROJECT elements)
type	Determine the attributes of IODATA/PROJECT elements in the query

Returns: The parsed reply of the RedDot server as XmlDocument

Here is the caller graph for this function:

string erminas.SmartAPI.CMS.Project.IProject.GetTextContent	(	Guid	textElementGuid,
		ILanguageVariant	lang,
		string	typeString
	)

CMS.Session.GetTextContent

IProject erminas.SmartAPI.CMS.Project.IProject.Refreshed ( )

void erminas.SmartAPI.CMS.Project.IProject.Select ( )

Select this project as active project in the current session.

void erminas.SmartAPI.CMS.Project.IProject.SetLockLevel	(	ProjectLockLevel	level,
		string	infoMessage
	)

Set the project lock. The info message must not be empty, if lock level is different than ProjectLockLevel.None!

Parameters

level	level to set the locking to
infoMessage	info message to display to users, MUST NOT BE EMPTY if lock level is different than ProjectLockLevel.None

Guid erminas.SmartAPI.CMS.Project.IProject.SetTextContent	(	Guid	textElementGuid,
		ILanguageVariant	languageVariant,
		string	typeString,
		string	content
	)

CMS.Session.SetTextContent

Property Documentation

IProjectGroups erminas.SmartAPI.CMS.Project.IProject.AssignedGroups

get

Definition at line 107 of file IProject.cs.

ICategories erminas.SmartAPI.CMS.Project.IProject.Categories

get

Definition at line 110 of file IProject.cs.

IProjectClipboard erminas.SmartAPI.CMS.Project.IProject.Clipboard

get

Definition at line 113 of file IProject.cs.

IContentClasses erminas.SmartAPI.CMS.Project.IProject.ContentClasses

get

Definition at line 120 of file IProject.cs.

IContentClassFolders erminas.SmartAPI.CMS.Project.IProject.ContentClassFolders

get

All content class folders, indexed by name. The list is cached by default.

Definition at line 118 of file IProject.cs.

IDatabaseConnections erminas.SmartAPI.CMS.Project.IProject.DatabaseConnections

get

All database connections, indexed by name. The list is cached by default.

Definition at line 125 of file IProject.cs.

IFolders erminas.SmartAPI.CMS.Project.IProject.Folders

get

All folders, indexed by name. The list is cached by default.

Definition at line 130 of file IProject.cs.

IIndexedCachedList<int, IInfoAttribute> erminas.SmartAPI.CMS.Project.IProject.InfoAttributes

get

All info attributes in the project, indexed by id. The list is cached by default.

Definition at line 135 of file IProject.cs.

bool erminas.SmartAPI.CMS.Project.IProject.IsArchivingActive

get

Definition at line 143 of file IProject.cs.

bool erminas.SmartAPI.CMS.Project.IProject.IsLockedBySystem

get

Definition at line 145 of file IProject.cs.

bool erminas.SmartAPI.CMS.Project.IProject.IsVersioningActive

getset

Definition at line 147 of file IProject.cs.

IRDList<IKeyword> erminas.SmartAPI.CMS.Project.IProject.Keywords

get

All keywords. The list is cached by default.

Definition at line 152 of file IProject.cs.

ILanguageVariants erminas.SmartAPI.CMS.Project.IProject.LanguageVariants

get

All language variants, indexed by Language. The list is cached by default.

Definition at line 157 of file IProject.cs.

ProjectLockLevel erminas.SmartAPI.CMS.Project.IProject.LockLevel

get

The project lock level.

Definition at line 162 of file IProject.cs.

IIndexedRDList<string, IUser> erminas.SmartAPI.CMS.Project.IProject.OnlineUsers

get

Get users currently logged into this project Requires you to have ServerManager rights.

Definition at line 141 of file IProject.cs.

IPages erminas.SmartAPI.CMS.Project.IProject.Pages

get

Definition at line 164 of file IProject.cs.

IProjectVariants erminas.SmartAPI.CMS.Project.IProject.ProjectVariants

get

All project variants, indexed by name. The list is cached by default.

Definition at line 169 of file IProject.cs.

IRDList<IPublicationFolder> erminas.SmartAPI.CMS.Project.IProject.PublicationFolders

get

All publication folders

Definition at line 174 of file IProject.cs.

IRDList<IPublicationPackage> erminas.SmartAPI.CMS.Project.IProject.PublicationPackages

get

All publication packages

Definition at line 179 of file IProject.cs.

IRDList<IPublicationTarget> erminas.SmartAPI.CMS.Project.IProject.PublicationTargets

get

All publication targets

Definition at line 184 of file IProject.cs.

IRecycleBin erminas.SmartAPI.CMS.Project.IProject.RecycleBin

get

Definition at line 186 of file IProject.cs.

ISyllables erminas.SmartAPI.CMS.Project.IProject.Syllables

get

All Syllables, indexed by guid. The list is cached by default.

Definition at line 191 of file IProject.cs.

IProjectUsers erminas.SmartAPI.CMS.Project.IProject.Users

get

All users of the project and their access levels, indexed by user name. The list is cached by default.

Definition at line 196 of file IProject.cs.

IProjectWorkflows erminas.SmartAPI.CMS.Project.IProject.Workflows

get

Definition at line 198 of file IProject.cs.

The documentation for this interface was generated from the following file:

IProject.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation