API Documentation

Classes

DublinCore , MutableDublinCore , CatalogableDublinCore

Dublin Core interface.

$Id: DublinCore.py 36613 2004-10-12 09:22:52Z yuppie $

class DublinCore

Dublin Core metadata elements supported by CMF and their semantics.

Methods

Publisher():

Dublin Core Publisher element - resource publisher.

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

Permission: View
Returns: String

Identifier():

Dublin Core Identifier element - resource ID.

Returns unique ID (a URL) for the resource.

Permission: View
Returns: String

Description():

Dublin Core Description element - resource summary.

Return a natural language description of this object.

Permission: View
Returns: String

Contributors():

Deprecated alias of listContributors.

initial caps names are reserved for strings.

Creator():

Dublin Core Creator element - resource author.

The first Dublin Core Creator element or an empty string.

Permission: View
Returns: String

listCreators():

List Dublin Core Creator elements - resource authors.

Depending on the implementation, this returns the full name(s) of the author(s) of the content object or their ids.

Permission: View
Returns: Sequence of strings

listContributors():

Dublin Core Contributor elements - resource collaborators.

Return zero or additional collaborators.

Permission: View
Returns: Sequence of strings

Rights():

Dublin Core Rights element - resource copyright.

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

Permission: View
Returns: String

ModificationDate():

Dublin Core Date element - date resource last modified.

Permission: View
Returns: String, formatted YYYY-MM-DD H24:MN:SS TZ

EffectiveDate():

Dublin Core Date element - date resource becomes effective.

Permission: View
Returns: String, formatted YYYY-MM-DD H24:MN:SS TZ

Date():

Dublin Core Date element - default date.

Permission: View
Returns: String, formatted YYYY-MM-DD H24:MN:SS TZ

Language():

Dublin Core Language element - resource language.

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

Permission: View
Returns: String

ExpirationDate():

Dublin Core Date element - date resource expires.

Permission: View
Returns: String, formatted YYYY-MM-DD H24:MN:SS TZ

Title():

Dublin Core Title element - resource name.

Permission: View
Returns: String

Format():

Dublin Core Format element - resource format.

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

Permission: View
Returns: String

CreationDate():

Dublin Core Date element - date resource created.

Permission: View
Returns: String, formatted YYYY-MM-DD H24:MN:SS TZ

Type():

Dublin Core Type element - resource type.

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

Permission: View
Returns: String

Subject():

Dublin Core Subject element - resource keywords.

Return zero or more keywords associated with the content object.

Permission: View
Returns: Sequence of strings

class MutableDublinCore

Update interface for mutable metadata.

Methods

setDescription(description):

Set Dublin Core Description element - resource summary.

Permission: Modify portal content

setContributors(contributors):

Set Dublin Core Contributor elements - resource collaborators.

Permission: Modify portal content

setFormat(format):

Set Dublin Core Format element - resource format.

Permission: Modify portal content

setTitle(title):

Set Dublin Core Title element - resource name.

Permission: Modify portal content

setExpirationDate(expiration_date):

Set Dublin Core Date element - date resource expires.

Permission: Modify portal content

setRights(rights):

Set Dublin Core Rights element - resource copyright.

Permission: Modify portal content

setSubject(subject):

Set Dublin Core Subject element - resource keywords.

Permission: Modify portal content

setCreators(creators):

Set Dublin Core Creator elements - resource authors.

Permission: Modify portal content

setEffectiveDate(effective_date):

Set Dublin Core Date element - date resource becomes effective.

Permission: Modify portal content

setLanguage(language):

Set Dublin Core Language element - resource language.

Permission: Modify portal content

class CatalogableDublinCore

Provide Zope-internal date objects for cataloging purposes.

Methods

effective():

Dublin Core Date element - date resource becomes effective.

Permission: View
Returns: DateTime

created():

Dublin Core Date element - date resource created.

Permission: View
Returns: DateTime

expires():

Dublin Core Date element - date resource expires.

Permission: View
Returns: DateTime

modified():

Dublin Core Date element - date resource last modified.

Permission: View
Returns: DateTime