com.tle.web.scripting.advanced.types
Interface DrmSettingsScriptType
Declaration: public interface DrmSettingsScriptType extends java.io.Serializable
All Superinterfaces: java.io.Serializable

 

 

Methods Summary
abstract void addContentOwner(DrmPartyScriptType party)
    
abstract boolean addUsage(java.lang.String usage)
    
abstract java.util.List<DrmPartyScriptType> getContentOwners()
     Owners of the rights over item content
abstract int getMaximumUsageCount()
    
abstract java.lang.String getRequireAcceptanceFrom()
    
abstract java.util.List<java.lang.String> getRestrictedToRecipients()
    
abstract java.lang.String getTermsOfAgreement()
    
abstract java.util.List<java.lang.String> getUsages()
    
abstract boolean isAllowSummary()
    
abstract boolean isAttributionOfOwnership()
     true if , otherwise false.
abstract boolean isEnforceAttribution()
     true if , otherwise false.
abstract boolean isHideLicencesFromOwner()
     true if , otherwise false.
abstract boolean isOwnerMustAccept()
     true if owner required to accept rights statement, otherwise false.
abstract boolean isPreviewAllowed()
     true if user may view a preview of the item without having explicitly accepted rights statement, otherwise false.
abstract boolean isRestrictToSector()
     true if , otherwise false.
abstract boolean isShowLicenceCount()
     true if , otherwise false.
abstract boolean isStudentsMustAcceptIfInCompilation()
     true if users still required to accept the licence statement if the item is used in a composition.
abstract boolean removeUsage(java.lang.String usage)
    
abstract void setAllowSummary(boolean allowSummary)
    
abstract void setAttributionOfOwnership(boolean attributionOfOwnership)
     Specify that
abstract void setContentOwners(java.util.List<DrmPartyScriptType> contentOwners)
    
abstract void setEnforceAttribution(boolean enforceAttribution)
     Specify that
abstract void setHideLicencesFromOwner(boolean hideLicencesFromOwner)
     Specify that
abstract void setMaximumUsageCount(int maximumUsageCount)
    
abstract void setOwnerMustAccept(boolean ownerMustAccept)
     Specify that the owner is (also) required to accept rights statement, otherwise false.
abstract void setPreviewAllowed(boolean previewAllowed)
     Specify that user may view a preview of the item without having explicitly accepted rights statement.
abstract void setRequireAcceptanceFrom(java.lang.String requireAcceptanceFrom)
    
abstract void setRestrictedToRecipients(java.util.List<java.lang.String> restrictedToRecipients)
    
abstract void setRestrictToSector(boolean restrictToSector)
     Specify that
abstract void setShowLicenceCount(boolean showLicenceCount)
     Specify that
abstract void setStudentsMustAcceptIfInCompilation(boolean studentsMustAcceptIfInCompilation)
     Specify that users still required to accept the licence statement if the item is used in a composition.
abstract void setTermsOfAgreement(java.lang.String termsOfAgreement)
    
abstract void setUsages(java.util.List<java.lang.String> usages)
    

 

 

 

 

isAllowSummary

 

public abstract boolean isAllowSummary( )

 

 

 

setAllowSummary

 

public abstract void setAllowSummary( boolean allowSummary)

 

 

 

isOwnerMustAccept

 

public abstract boolean isOwnerMustAccept( )

 

true if owner required to accept rights statement, otherwise false.

 

Returns:
primitive boolean true or false

 

 

 

setOwnerMustAccept

 

public abstract void setOwnerMustAccept( boolean ownerMustAccept)

 

Specify that the owner is (also) required to accept rights statement, otherwise false.

 

Parameters:
ownerMustAccept-
primitive boolean true or false

 

 

 

isPreviewAllowed

 

public abstract boolean isPreviewAllowed( )

 

true if user may view a preview of the item without having explicitly accepted rights statement, otherwise false.

 

Returns:
primitive boolean true or false

 

 

 

setPreviewAllowed

 

public abstract void setPreviewAllowed( boolean previewAllowed)

 

Specify that user may view a preview of the item without having explicitly accepted rights statement.

 

Parameters:
previewAllowed-
primitive boolean true or false

 

 

 

isStudentsMustAcceptIfInCompilation

 

public abstract boolean isStudentsMustAcceptIfInCompilation( )

 

true if users still required to accept the licence statement if the item is used in a composition.

 

Returns:
primitive boolean true or false

 

 

 

setStudentsMustAcceptIfInCompilation

 

public abstract void setStudentsMustAcceptIfInCompilation( boolean studentsMustAcceptIfInCompilation)

 

Specify that users still required to accept the licence statement if the item is used in a composition.

 

Parameters:
studentsMustAcceptIfInCompilation-
primitive boolean true or false

 

 

 

getContentOwners

 

public abstract java.util.List<DrmPartyScriptType> getContentOwners( )

 

Owners of the rights over item content

 

Returns:
List owners of the rights of item content

 

See also: DrmPartyScriptType

 

 

 

setContentOwners

 

public abstract void setContentOwners( java.util.List<DrmPartyScriptType> contentOwners)

 

 

 

addContentOwner

 

public abstract void addContentOwner( DrmPartyScriptType party)

 

Parameters:
party-
A DrmPartyScriptType object obtained via DrmScriptObject or DrmScriptObject

 

 

 

getUsages

 

public abstract java.util.List<java.lang.String> getUsages( )

 

 

 

setUsages

 

public abstract void setUsages( java.util.List<java.lang.String> usages)

 

 

 

addUsage

 

public abstract boolean addUsage( java.lang.String usage)

 

Parameters:
usage-
One of: DISPLAY, PRINT, PLAY, EXECUTE, AGGREGATE, MODIFY, EXCERPT, ANNOTATE
Returns:
true if the usage did not already exist and was added.

 

 

 

removeUsage

 

public abstract boolean removeUsage( java.lang.String usage)

 

Parameters:
usage-
One of: DISPLAY, PRINT, PLAY, EXECUTE, AGGREGATE, MODIFY, EXCERPT, ANNOTATE
Returns:
true if the given usage was found and removed.

 

 

 

isAttributionOfOwnership

 

public abstract boolean isAttributionOfOwnership( )

 

true if , otherwise false.

 

Returns:
primitive boolean true or false

 

 

 

setAttributionOfOwnership

 

public abstract void setAttributionOfOwnership( boolean attributionOfOwnership)

 

Specify that

 

Parameters:
attributionOfOwnership-
primitive boolean true or false

 

 

 

isEnforceAttribution

 

public abstract boolean isEnforceAttribution( )

 

true if , otherwise false.

 

Returns:
primitive boolean true or false

 

 

 

setEnforceAttribution

 

public abstract void setEnforceAttribution( boolean enforceAttribution)

 

Specify that

 

Parameters:
enforceAttribution-
primitive boolean true or false

 

 

 

getRestrictedToRecipients

 

public abstract java.util.List<java.lang.String> getRestrictedToRecipients( )

 

 

 

setRestrictedToRecipients

 

public abstract void setRestrictedToRecipients( java.util.List<java.lang.String> restrictedToRecipients)

 

 

 

isRestrictToSector

 

public abstract boolean isRestrictToSector( )

 

true if , otherwise false.

 

Returns:
primitive boolean true or false

 

 

 

setRestrictToSector

 

public abstract void setRestrictToSector( boolean restrictToSector)

 

Specify that

 

Parameters:
restrictToSector-
primitive boolean true or false

 

 

 

getTermsOfAgreement

 

public abstract java.lang.String getTermsOfAgreement( )

 

 

 

setTermsOfAgreement

 

public abstract void setTermsOfAgreement( java.lang.String termsOfAgreement)

 

 

 

getMaximumUsageCount

 

public abstract int getMaximumUsageCount( )

 

 

 

setMaximumUsageCount

 

public abstract void setMaximumUsageCount( int maximumUsageCount)

 

 

 

isHideLicencesFromOwner

 

public abstract boolean isHideLicencesFromOwner( )

 

true if , otherwise false.

 

Returns:
primitive boolean true or false

 

 

 

setHideLicencesFromOwner

 

public abstract void setHideLicencesFromOwner( boolean hideLicencesFromOwner)

 

Specify that

 

Parameters:
hideLicencesFromOwner-
primitive boolean true or false

 

 

 

isShowLicenceCount

 

public abstract boolean isShowLicenceCount( )

 

true if , otherwise false.

 

Returns:
primitive boolean true or false

 

 

 

setShowLicenceCount

 

public abstract void setShowLicenceCount( boolean showLicenceCount)

 

Specify that

 

Parameters:
showLicenceCount-
primitive boolean true or false

 

 

 

getRequireAcceptanceFrom

 

public abstract java.lang.String getRequireAcceptanceFrom( )

 

 

 

setRequireAcceptanceFrom

 

public abstract void setRequireAcceptanceFrom( java.lang.String requireAcceptanceFrom)