IPage.cs

Go to the documentation of this file.

// SmartAPI - .Net programmatic access to RedDot servers
//  
// Copyright (C) 2013 erminas GbR
// 
// This program is free software: you can redistribute it and/or modify it 
// under the terms of the GNU General Public License as published by the Free Software Foundation,
// either version 3 of the License, or (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License along with this program.
// If not, see <http://www.gnu.org/licenses/>.

using System;
using System.Collections.Generic;
using erminas.SmartAPI.CMS.Project.ContentClasses;
using erminas.SmartAPI.CMS.Project.Pages.Elements;
using erminas.SmartAPI.CMS.Project.Workflows;
using erminas.SmartAPI.CMS.ServerManagement;
using erminas.SmartAPI.Exceptions;
using erminas.SmartAPI.Utils.CachedCollections;

namespace erminas.SmartAPI.CMS.Project.Pages
{
    public enum PageType
    {
        All = 0,
        Released = 1,
        Unlinked = 8192,
        Draft = 262144
    };

    public enum Replace
    {
        OnlyForThisPage,
        ForAllPagesOfContentClass
    }

    public enum PageState
    {
        NotSet = 0,
        IsReleased = 1,
        WaitsForRelease = 2,
        WaitsForCorrection = 3,
        SavedAsDraft = 4,
        NotAvailableInLanguage = 5,

        NeverHasBeenReleasedInOriginalLanguage = 6,
        IsInRecycleBin = 10,
        WillBeArchived = 50,
        WillBeRemovedCompletely = 99
    }

    [Flags]
    public enum PageReleaseStatus
    {
        Draft = 65536,
        WorkFlow = 32768,
        Released = 4096,
        NotSet = 0,
        Rejected = 16384
    };

    [Flags]
    public enum PageFlags
    {
        NotSet = 0,
        NotForBreadcrumb = 4,
        Workflow = 64,
        WaitingForTranslation = 1024,
        Unlinked = 8192,
        WaitingForCorrection = 131072,
        Draft = 262144,
        Released = 524288,
        BreadCrumbStaringPoint = 2097152,
        ContainsExternalReference = 8388608,
        OwnPageWaitingForRelease = 134217728,
        Locked = 268435456,
        Null = -1
    }

    public enum PreviewHtmlType
    {
        Raw = 0,
        AddCmsBaseUrlToHeadSection
    }

    public interface IPage : ILinkTarget, IPartialRedDotProjectObject, IKeywordAssignable, IDeletable, IDetailedAuthorizable, IReferencePreassignTarget
    {
        DateTime CreateDate { get; }

        DateTime CheckinDate { get; }

        DateTime LastChangeDate { get; }

        IUser LastChangeUser { get; }

        void Commit();

        IContentClass ContentClass { get; }

        IIndexedRDList<string, IPageElement> ContentElements { get; }

        [Obsolete("This method is experimental and probably will change in a future version")]
        IPageCopyAndConnectJob CreateCopyAndConnectJob(ILinkElement connectionTarget,
            PageCopyAndConnectFlags flags = PageCopyAndConnectFlags.None);

        [Obsolete("This method is experimental and probably will change in a future version")]
        void CopyAndConnectAsync(ILinkElement connectionTarget,
            PageCopyAndConnectFlags flags = PageCopyAndConnectFlags.None);

        new void Delete();

        void DeleteFromRecycleBin();

        void DeleteIfNotReferenced();

        void DeleteIrrevocably(int maxWaitForDeletionInMs = 1250);

        void DisconnectFromParent();

        bool Exists { get; }

        string Filename { get; set; }

        string Headline { get; set; }

        int Id { get; }

        IPageElement this[string elementName] { get; }

        ILanguageVariant LanguageVariant { get; }

        IRDList<ILinkElement> LinkElements { get; }

        IRDList<ILinkingAndAppearance> LinkedFrom { get; }

        ILinkElement MainParentLinkElement { get; set; }

        [Obsolete("This is the PARENT link of the page, in a future version this will change to the main navigation link element of this page.")]
        ILinkElement MainLinkElement { get; set; }

        [VersionIsGreaterThanOrEqual(9, VersionName = "Version 9")]
        ILinkElement MainLinkNavigationElement { get; set; }

        new string Name { get; set; }

        IPage Parent { get; }

        IPage Refreshed();

        void Reject();

        void Release();

        DateTime ReleaseDate { get; }

        PageReleaseStatus ReleaseStatus { get; set; }

        void ReplaceContentClass(IContentClass replacement, IDictionary<string, string> oldToNewMapping, Replace replace);

        void ResetToDraft();

        void Restore();

        void SkipWorkflow();

        PageState Status { get; set; }

        void SubmitToWorkflow();

        void Undo();

        IWorkflow Workflow { get; }

        IPagePublishJob CreatePublishJob();

        string GetPreviewHtml(PreviewHtmlType previewType);
    }
}