Logo Search packages:      
Sourcecode: zope-cmf version File versions

DublinCore.py

##############################################################################
#
# Copyright (c) 2001 Zope Corporation and Contributors. All Rights Reserved.
# 
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE
# 
##############################################################################
import Interface

00015 class DublinCore(Interface.Base):
    """
        Define which Dublin Core metadata elements are supported by the PTK,
        and the semantics therof.
    """

00021     def Title():
        """
            Dublin Core element - resource name

            Return type: string
            Permissions: View
        """
        
00029     def Creator():
        """
            Dublin Core element - resource creator

            Return the full name(s) of the author(s) of the content object.

            Return type: string
            Permission: View
        """

00039     def Subject():
        """
            Dublin Core element - resource keywords

            Return zero or more keywords associated with the content object.

            Return type: sequence of strings
            Permission: View
        """

00049     def Description():
        """
            Dublin Core element - resource summary

            Return a natural language description of this object.

            Return type: string
            Permissions: View
        """

00059     def Publisher():
        """
            Dublin Core element - resource publisher

            Return full formal name of the entity or person responsible
            for publishing the resource.

            Return type: string
            Permission: View
        """

00070     def Contributors():
        """
            Dublin Core element - resource collaborators

            Return zero or additional collaborators.

            Return type: sequence of strings
            Permission: View
        """
    
00080     def Date():
        """
            Dublin Core element - default date

            Return type: string, formatted 'YYYY-MM-DD H24:MN:SS TZ'
            Permissions: View
        """
    
00088     def CreationDate():
        """
            Dublin Core element - date resource created.

            Return type: string, formatted 'YYYY-MM-DD H24:MN:SS TZ'
            Permissions: View
        """
    
00096     def EffectiveDate():
        """
            Dublin Core element - date resource becomes effective.

            Return type: string, formatted 'YYYY-MM-DD H24:MN:SS TZ'
            Permissions: View
        """
    
00104     def ExpirationDate():
        """
            Dublin Core element - date resource expires.

            Return type: string, formatted 'YYYY-MM-DD H24:MN:SS TZ'
            Permissions: View
        """
    
00112     def ModificationDate():
        """
            Dublin Core element - date resource last modified.

            Return type: string, formatted 'YYYY-MM-DD H24:MN:SS TZ'
            Permissions: View
        """

00120     def Type():
        """
            Dublin Core element - resource type

            Return a human-readable type name for the resource
            (perhaps mapped from its Zope meta_type).

            Return type: string
            Permissions: View
        """

00131     def Format():
        """
            Dublin Core element - resource format

            Return the resource's MIME type (e.g., 'text/html',
            'image/png', etc.).

            Return type: string
            Permissions: View
        """

00142     def Identifier():
        """
            Dublin Core element - resource ID

            Returns unique ID (a URL) for the resource.

            Return type: string
            Permissions: View
        """

00152     def Language():
        """
            Dublin Core element - resource language

            Return the RFC language code (e.g., 'en-US', 'pt-BR')
            for the resource.

            Return type: string
            Permissions: View
        """

00163     def Rights():
        """
            Dublin Core element - resource copyright

            Return a string describing the intellectual property status,
            if any, of the resource.
            for the resource.

            Return type: string
            Permissions: View
        """

00175 class CatalogableDublinCore(Interface.Base):
    """
        Provide Zope-internal date objects for cataloging purposes.
    """
00179     def created():
        """
            Dublin Core element - date resource created,

            Return type: DateTime
            Permissions: View
        """
    
00187     def effective():
        """
            Dublin Core element - date resource becomes effective,

            Return type: DateBound
            Permissions: View
        """
    
00195     def expires():
        """
            Dublin Core element - date resource expires,

            Return type: DateBound
            Permissions: View
        """
    
00203     def modified():
        """
            Dublin Core element - date resource last modified,

            Return type: DateTime
            Permissions: View
        """

00211 class MutableDublinCore(Interface.Base):
    """
        Update interface for mutable metadata.
    """
    def setTitle(title):
        "Dublin Core element - update resource name"

    def setSubject(subject):
        "Dublin Core element - update resource keywords"

    def setDescription(description):
        "Dublin Core element - update resource summary"

    def setContributors(contributors):
        "Dublin Core element - update additional contributors to resource"

00227     def setEffectiveDate(effective_date):
        """ Dublin Core element - update date resource becomes effective.  """
    
00230     def setExpirationDate(expiration_date):
        """ Dublin Core element - update date resource expires.  """
    
00233     def setFormat(format):
        """ Dublin Core element - update resource format """

00236     def setLanguage(language):
        """ Dublin Core element - update resource language """

00239     def setRights(rights):
        """ Dublin Core element - update resource copyright """


Generated by  Doxygen 1.6.0   Back to index