com.wewebu.ow.server.ecm
Interface OwContentCollection

All Known Implementing Classes:
OwDocumentImportItemContentCollection, OwFileObject, OwStandardContentCollection

public interface OwContentCollection

Base interface for Content Collections. Content Collections hold several content types with several pages each.
Each page can contain a different content representation, which are URL, Stream and Object.
The count of all available pages is returned with the zero based index function getPageCount(). However, the actual page number must be retrieved with the one based function getPageNumber().

e.g.: the ContentCollection could hold content for 3 pages with page numbers 5, 19, 201.

Calls to getPageNumber would result as follows:

  • getPageNumber(0) = 5
  • getPageNumber(1) = 19
  • getPageNumber(2) = 201


  • For the getter methods to work, you must use the page number rather than the page index.

    e.g.: getContentURL(CONTENT_TYPE_DOCUMENT,getPageNumber(0) would retrieve the document content of the page number 5, which has index 0.

    To be implemented with the specific ECM system.

    Alfresco Workdesk
    Copyright (c) Alfresco Software, Inc.
    All rights reserved.

    For licensing information read the license.txt file or
    go to: http://wiki.alfresco.com


    Field Summary
    static int CONTENT_REPRESENTATION_TYPE_NONE
              content representation type
    static int CONTENT_REPRESENTATION_TYPE_OBJECT
              content representation type
    static int CONTENT_REPRESENTATION_TYPE_STREAM
              content representation type
    static int CONTENT_REPRESENTATION_TYPE_URL
              content representation type
    static int CONTENT_REPRESENTATION_TYPE_USER_START
              start value for user defined content representation types
    static int CONTENT_TYPE_ANNOTATION
              content type Annotation enumerator
    static int CONTENT_TYPE_DOCUMENT
              content type Document enumerator
    static int CONTENT_TYPE_SECURITY
              content type Security enumerator
    static int CONTENT_TYPE_USER_START
              start value for user defined content types
     
    Method Summary
     OwContentElement getContentElement(int iContentType_p, int iPage_p)
              get a content element for the given type and page
     Collection getContentTypes()
              get a list of content types used in this object
     int getPageCount()
              retrieve the page count NOTE: You can iterate through all pages by looping a index value from zero to getPageCount and use getPageNumber to resolve the actually page number.
     

    Field Detail

    CONTENT_TYPE_DOCUMENT

    static final int CONTENT_TYPE_DOCUMENT
    content type Document enumerator

    See Also:
    Constant Field Values

    CONTENT_TYPE_ANNOTATION

    static final int CONTENT_TYPE_ANNOTATION
    content type Annotation enumerator

    See Also:
    Constant Field Values

    CONTENT_TYPE_SECURITY

    static final int CONTENT_TYPE_SECURITY
    content type Security enumerator

    See Also:
    Constant Field Values

    CONTENT_TYPE_USER_START

    static final int CONTENT_TYPE_USER_START
    start value for user defined content types

    See Also:
    Constant Field Values

    CONTENT_REPRESENTATION_TYPE_NONE

    static final int CONTENT_REPRESENTATION_TYPE_NONE
    content representation type

    See Also:
    Constant Field Values

    CONTENT_REPRESENTATION_TYPE_STREAM

    static final int CONTENT_REPRESENTATION_TYPE_STREAM
    content representation type

    See Also:
    Constant Field Values

    CONTENT_REPRESENTATION_TYPE_URL

    static final int CONTENT_REPRESENTATION_TYPE_URL
    content representation type

    See Also:
    Constant Field Values

    CONTENT_REPRESENTATION_TYPE_OBJECT

    static final int CONTENT_REPRESENTATION_TYPE_OBJECT
    content representation type

    See Also:
    Constant Field Values

    CONTENT_REPRESENTATION_TYPE_USER_START

    static final int CONTENT_REPRESENTATION_TYPE_USER_START
    start value for user defined content representation types

    See Also:
    Constant Field Values
    Method Detail

    getContentElement

    OwContentElement getContentElement(int iContentType_p,
                                       int iPage_p)
                                       throws Exception
    get a content element for the given type and page

    Parameters:
    iContentType_p - int
    iPage_p - int
    Returns:
    OwContentElement
    Throws:
    Exception

    getPageCount

    int getPageCount()
                     throws Exception
    retrieve the page count NOTE: You can iterate through all pages by looping a index value from zero to getPageCount and use getPageNumber to resolve the actually page number.

    Returns:
    long page count
    Throws:
    Exception

    getContentTypes

    Collection getContentTypes()
                               throws Exception
    get a list of content types used in this object

    Returns:
    List of int content types
    Throws:
    Exception


    Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.