|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PartType
Method Summary | |
---|---|
void |
clearDescriptions()
|
void |
clearLabels()
|
java.lang.String |
getDescription(java.util.Locale locale)
|
java.lang.String |
getDescriptionExact(java.util.Locale locale)
|
java.util.Locale[] |
getDescriptionLocales()
Returns the locales for which a description is set. |
long |
getId()
|
java.lang.String |
getLabel(java.util.Locale locale)
Gets the label in the given locale, using the usual locale fallback mechanisms if not found in the exactly specified locale, and finally returning the parttype's name if no label is available. |
java.lang.String |
getLabelExact(java.util.Locale locale)
|
java.util.Locale[] |
getLabelLocales()
|
java.util.Date |
getLastModified()
When was this PartType last changed (persistently). |
long |
getLastModifier()
Who (which user) last changed this PartType (persistently). |
java.lang.String |
getLinkExtractor()
Returns the name of the link extractor to use for parts of this type, can be null. |
java.lang.String |
getMimeTypes()
Returns a string describing limitations on the allowed mime-types. |
java.lang.String |
getName()
|
long |
getUpdateCount()
|
org.outerx.daisy.x10.PartTypeDocument |
getXml()
|
boolean |
isDaisyHtml()
Indicates if the content of the part is Daisy HTML (well-formed XML using HTML elements). |
boolean |
isDeprecated()
|
boolean |
mimeTypeAllowed(java.lang.String mimeType)
|
void |
save()
|
void |
setAllFromXml(org.outerx.daisy.x10.PartTypeDocument.PartType partTypeXml)
Changes the state of this object to match the given XML. |
void |
setDaisyHtml(boolean daisyHtml)
Sets the Daisy-HTML flag. |
void |
setDeprecated(boolean deprecated)
|
void |
setDescription(java.util.Locale locale,
java.lang.String description)
|
void |
setLabel(java.util.Locale locale,
java.lang.String label)
|
void |
setLinkExtractor(java.lang.String name)
|
void |
setMimeTypes(java.lang.String mimeTypes)
Specify the type of data that is allowed in parts of this type based on the mime-type. |
void |
setName(java.lang.String name)
|
Method Detail |
---|
long getId()
java.lang.String getName()
void setName(java.lang.String name)
java.lang.String getLabel(java.util.Locale locale)
java.lang.String getLabelExact(java.util.Locale locale)
void setLabel(java.util.Locale locale, java.lang.String label)
label
- if null, the label for this locale will be removed.void clearLabels()
java.util.Locale[] getLabelLocales()
java.lang.String getDescription(java.util.Locale locale)
java.lang.String getDescriptionExact(java.util.Locale locale)
void setDescription(java.util.Locale locale, java.lang.String description)
description
- if null, the description for this locale will be removed.void clearDescriptions()
java.util.Locale[] getDescriptionLocales()
java.lang.String getMimeTypes()
void setMimeTypes(java.lang.String mimeTypes)
mimeTypes
- A comma-separated list of mime-types. If empty, all mime-types are allowed.boolean mimeTypeAllowed(java.lang.String mimeType)
boolean isDaisyHtml()
void setDaisyHtml(boolean daisyHtml)
Note: when the argument daisyHTML is true, the link extractor will be forced to "daisy-html", for reasons of back-compatibility (in the past, link extractors were not explicitely configurable, and link extraction always happened for daisy-html parts). It is possible to override this again by calling setLinkExtractor after setDaisyHtml.
void setLinkExtractor(java.lang.String name)
name
- allowed to be nulljava.lang.String getLinkExtractor()
boolean isDeprecated()
void setDeprecated(boolean deprecated)
java.util.Date getLastModified()
long getLastModifier()
org.outerx.daisy.x10.PartTypeDocument getXml()
void setAllFromXml(org.outerx.daisy.x10.PartTypeDocument.PartType partTypeXml)
void save() throws RepositoryException
RepositoryException
long getUpdateCount()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |