es.gob.afirma.tsl.parsing.impl.common

Class SchemeInformation

java.lang.Object

es.gob.afirma.tsl.parsing.impl.common.SchemeInformation

All Implemented Interfaces:

java.io.Serializable

public class SchemeInformation
extends java.lang.Object
implements java.io.Serializable

Class that defines the TSL Scheme Information with all its information not dependent of the specification or TSL version.

Project:

Library for the integration with the services of @Firma, eVisor and TS@.

Version:

1.0, 10/11/2020.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemeInformation() Constructor method for the class SchemeInformation.java.

Method Summary

Modifier and Type	Method and Description
void	addNewDistributionPoint(java.net.URI dpUri) Adds a new distribution point.
void	addNewLegalNotice(java.lang.String language, java.lang.String legalNotice) Adds a new scheme legal notice in a specific language.
void	addNewPointerToOtherTSL(TSLPointer pointer) Adds a new pointer to other TSL.
void	addNewPolicy(java.lang.String language, java.net.URI policyUri) Adds a new scheme policy in a specific language.
void	addNewSchemeInformationExtension(IAnyTypeExtension extension) Adds a new extension if it is not null.
void	addNewSchemeInformationURI(java.lang.String language, java.net.URI schemeInformationURI) Adds a new scheme information URI for the specified language.
void	addNewSchemeName(java.lang.String language, java.lang.String schemeName) Adds a new scheme name for the specified language.
void	addNewSchemeOperatorName(java.lang.String language, java.lang.String schemeOperatorName) Adds a new scheme operator name for the specified language.
void	addNewSchemeTypeCommunityRule(java.lang.String language, java.net.URI stcrUri) Adds a new scheme type community rule URI for the specified language.
java.util.List<java.net.URI>	getDistributionPoints() Gets the value of the attribute distributionPoints.
int	getHistoricalPeriod() Gets the value of the attribute historicalPeriod.
java.lang.String	getLegalNoticeInLanguage(java.lang.String language) Gets the notice from the input language.
java.util.Map<java.lang.String,java.lang.String>	getLegalNotices() Gets the value of the attribute legalNotices.
java.util.Date	getListIssueDateTime() Gets the value of the attribute listIssueDateTime.
java.util.Date	getNextUpdate() Gets the value of the attribute nextUpdate.
java.util.List<TSLPointer>	getPointersToOtherTSL() Gets the value of the attribute pointersToOtherTSL.
java.util.Map<java.lang.String,java.net.URI>	getPolicies() Gets the value of the attribute policies.
java.net.URI	getPolicyInLanguage(java.lang.String language) Gets the policy assigned to the input language.
java.util.List<IAnyTypeExtension>	getSchemeInformationExtensions() Gets the value of the attribute schemeInformationExtensions.
java.util.List<java.net.URI>	getSchemeInformationURIinLanguage(java.lang.String language) Gets the scheme information URI list for the specified language.
java.util.Map<java.lang.String,java.util.List<java.net.URI>>	getSchemeInformationURIs() Gets the value of the attribute schemeInformationURIs.
java.lang.String	getSchemeName(java.lang.String language) Gets the scheme name for the specified language.
java.util.Map<java.lang.String,java.lang.String>	getSchemeNames() Gets the value of the attribute schemeNames.
Address	getSchemeOperatorAddress() Gets the value of the attribute schemeOperatorAddress.
java.util.List<java.lang.String>	getSchemeOperatorNameInLanguage(java.lang.String language) Gets the scheme operator name for the specified language.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getSchemeOperatorNames() Gets the value of the attribute schemeOperatorNames.
java.lang.String	getSchemeTerritory() Gets the value of the attribute schemeTerritory.
java.util.Map<java.lang.String,java.util.List<java.net.URI>>	getSchemeTypeCommunityRules() Gets the value of the attribute schemeTypeCommunityRules.
java.util.List<java.net.URI>	getSchemeTypeCommunityRulesInLanguage(java.lang.String language) Gets the scheme type community rules for the specified language.
java.net.URI	getStatusDeterminationApproach() Gets the value of the attribute statusDeterminationApproach.
int	getTslSequenceNumber() Gets the value of the attribute tslSequenceNumber.
java.net.URI	getTslType() Gets the value of the attribute tslType.
int	getTslVersionIdentifier() Gets the value of the attribute tslVersionIdentifier.
boolean	isThereSomeDistributionPoint() Checks if there is at least one distribution point.
boolean	isThereSomeLegalNotice() Checks if there is at least one scheme legal notice.
boolean	isThereSomePointerToOtherTSL() Checks if there is at least one pointer to other TSL.
boolean	isThereSomePolicy() Checks if there is at least one scheme policy.
boolean	isThereSomeSchemeInformationExtension() Checks if there is at least one scheme information extension.
boolean	isThereSomeSchemeInformationURI() Checks if there is at least one scheme information URI.
boolean	isThereSomeSchemeName() Checks if there is at least one scheme name added.
boolean	isThereSomeSchemeTypeCommunityRule() Checks if there is at least one scheme type community rule.
void	setDistributionPoints(java.util.List<java.net.URI> distributionPointsParam) Sets the value of the attribute distributionPoints.
void	setHistoricalPeriod(int historicalPeriodParam) Sets the value of the attribute historicalPeriod.
void	setLegalNotices(java.util.Map<java.lang.String,java.lang.String> legalNoticesParam) Sets the value of the attribute legalNotices.
void	setListIssueDateTime(java.util.Date listIssueDateTimeParam) Sets the value of the attribute listIssueDateTime.
void	setNextUpdate(java.util.Date nextUpdateParam) Sets the value of the attribute nextUpdate.
void	setPointersToOtherTSL(java.util.List<TSLPointer> pointersToOtherTSLParam) Sets the value of the attribute pointersToOtherTSL.
void	setPolicies(java.util.Map<java.lang.String,java.net.URI> policiesParam) Sets the value of the attribute policies.
void	setSchemeNames(java.util.Map<java.lang.String,java.lang.String> schemeNamesParam) Sets the value of the attribute schemeNames.
void	setSchemeOperatorAddress(Address schemeOperatorAddressParam) Sets the value of the attribute schemeOperatorAddress.
void	setSchemeTerritory(java.lang.String schemeTerritoryParam) Sets the value of the attribute schemeTerritory.
void	setStatusDeterminationApproach(java.net.URI statusDeterminationApproachParam) Sets the value of the attribute statusDeterminationApproach.
void	setTslSequenceNumber(int tslSequenceNumberParam) Sets the value of the attribute tslSequenceNumber.
void	setTslType(java.net.URI tslTypeParam) Sets the value of the attribute tslType.
void	setTslVersionIdentifier(int tslVersionIdentifierParam) Sets the value of the attribute tslVersionIdentifier.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemeInformation

public SchemeInformation()

Constructor method for the class SchemeInformation.java.

Method Detail

getTslVersionIdentifier

public final int getTslVersionIdentifier()

Gets the value of the attribute tslVersionIdentifier.

Returns:

the value of the attribute tslVersionIdentifier.

setTslVersionIdentifier

public final void setTslVersionIdentifier(int tslVersionIdentifierParam)

Sets the value of the attribute tslVersionIdentifier.

Parameters:

tslVersionIdentifierParam - The value for the attribute tslVersionIdentifier.

getTslSequenceNumber

public final int getTslSequenceNumber()

Gets the value of the attribute tslSequenceNumber.

Returns:

the value of the attribute tslSequenceNumber.

setTslSequenceNumber

public final void setTslSequenceNumber(int tslSequenceNumberParam)

Sets the value of the attribute tslSequenceNumber.

Parameters:

tslSequenceNumberParam - The value for the attribute tslSequenceNumber.

getTslType

public final java.net.URI getTslType()

Gets the value of the attribute tslType.

Returns:

the value of the attribute tslType.

setTslType

public final void setTslType(java.net.URI tslTypeParam)

Sets the value of the attribute tslType.

Parameters:

tslTypeParam - The value for the attribute tslType.

getSchemeOperatorNames

public final java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSchemeOperatorNames()

Gets the value of the attribute schemeOperatorNames.

Returns:

the value of the attribute schemeOperatorNames.

getSchemeOperatorNameInLanguage

public final java.util.List<java.lang.String> getSchemeOperatorNameInLanguage(java.lang.String language)

Gets the scheme operator name for the specified language.

Parameters:

language - Language from which gets the scheme operator name.

Returns:

the scheme operator name for the specified language, or null if not exists for that language.

addNewSchemeOperatorName

public final void addNewSchemeOperatorName(java.lang.String language,
                                           java.lang.String schemeOperatorName)

Adds a new scheme operator name for the specified language.

Parameters:

language - language to which associate the new scheme operator name. If it is null, then this method do nothing.

schemeOperatorName - Scheme operator name.

getSchemeOperatorAddress

public final Address getSchemeOperatorAddress()

Gets the value of the attribute schemeOperatorAddress.

Returns:

the value of the attribute schemeOperatorAddress.

setSchemeOperatorAddress

public final void setSchemeOperatorAddress(Address schemeOperatorAddressParam)

Sets the value of the attribute schemeOperatorAddress.

Parameters:

schemeOperatorAddressParam - The value for the attribute schemeOperatorAddress.

getSchemeNames

public final java.util.Map<java.lang.String,java.lang.String> getSchemeNames()

Gets the value of the attribute schemeNames.

Returns:

the value of the attribute schemeNames.

getSchemeName

public final java.lang.String getSchemeName(java.lang.String language)

Gets the scheme name for the specified language.

Parameters:

language - Language from which gets the scheme name.

Returns:

Scheme name for the specified language, or null if not exists for that language.

addNewSchemeName

public final void addNewSchemeName(java.lang.String language,
                                   java.lang.String schemeName)

Adds a new scheme name for the specified language.

Parameters:

language - language to which associate the new scheme name. If it is null, then this method do nothing.

schemeName - Scheme name.

setSchemeNames

public final void setSchemeNames(java.util.Map<java.lang.String,java.lang.String> schemeNamesParam)

Sets the value of the attribute schemeNames.

Parameters:

schemeNamesParam - The value for the attribute schemeNames.

isThereSomeSchemeName

public final boolean isThereSomeSchemeName()

Checks if there is at least one scheme name added.

Returns:

true if there is, otherwise false.

getSchemeInformationURIs

public final java.util.Map<java.lang.String,java.util.List<java.net.URI>> getSchemeInformationURIs()

Gets the value of the attribute schemeInformationURIs.

Returns:

the value of the attribute schemeInformationURIs.

getSchemeInformationURIinLanguage

public final java.util.List<java.net.URI> getSchemeInformationURIinLanguage(java.lang.String language)

Gets the scheme information URI list for the specified language.

Parameters:

language - Language from which gets the scheme information URI.

Returns:

Scheme information URI list for the specified language, or null if not exists for that language.

addNewSchemeInformationURI

public final void addNewSchemeInformationURI(java.lang.String language,
                                             java.net.URI schemeInformationURI)

Adds a new scheme information URI for the specified language.

Parameters:

language - language to which associate the new scheme information URI. If it is null, then this method do nothing.

schemeInformationURI - Scheme information URI.

isThereSomeSchemeInformationURI

public final boolean isThereSomeSchemeInformationURI()

Checks if there is at least one scheme information URI.

Returns:

true if there is, otherwise false.

getStatusDeterminationApproach

public final java.net.URI getStatusDeterminationApproach()

Gets the value of the attribute statusDeterminationApproach.

Returns:

the value of the attribute statusDeterminationApproach.

setStatusDeterminationApproach

public final void setStatusDeterminationApproach(java.net.URI statusDeterminationApproachParam)

Sets the value of the attribute statusDeterminationApproach.

Parameters:

statusDeterminationApproachParam - The value for the attribute statusDeterminationApproach.

getSchemeTypeCommunityRules

public final java.util.Map<java.lang.String,java.util.List<java.net.URI>> getSchemeTypeCommunityRules()

Gets the value of the attribute schemeTypeCommunityRules.

Returns:

the value of the attribute schemeTypeCommunityRules.

getSchemeTypeCommunityRulesInLanguage

public final java.util.List<java.net.URI> getSchemeTypeCommunityRulesInLanguage(java.lang.String language)

Gets the scheme type community rules for the specified language.

Parameters:

language - Language from which gets the scheme type community rules.

Returns:

Scheme type community rules for the specified language, or null if not exists for that language.

addNewSchemeTypeCommunityRule

public final void addNewSchemeTypeCommunityRule(java.lang.String language,
                                                java.net.URI stcrUri)

Adds a new scheme type community rule URI for the specified language.

Parameters:

language - language to which associate the new scheme type community rule URI. If it is null, then this method do nothing.

stcrUri - scheme type community rule URI.

isThereSomeSchemeTypeCommunityRule

public final boolean isThereSomeSchemeTypeCommunityRule()

Checks if there is at least one scheme type community rule.

Returns:

true if there is, otherwise false.

getSchemeTerritory

public final java.lang.String getSchemeTerritory()

Gets the value of the attribute schemeTerritory.

Returns:

the value of the attribute schemeTerritory.

setSchemeTerritory

public final void setSchemeTerritory(java.lang.String schemeTerritoryParam)

Sets the value of the attribute schemeTerritory.

Parameters:

schemeTerritoryParam - The value for the attribute schemeTerritory.

getPolicies

public final java.util.Map<java.lang.String,java.net.URI> getPolicies()

Gets the value of the attribute policies.

Returns:

the value of the attribute policies.

getPolicyInLanguage

public final java.net.URI getPolicyInLanguage(java.lang.String language)

Gets the policy assigned to the input language.

Parameters:

language - language to search (ISO 639).

Returns:

URI that represents the searched policy.

addNewPolicy

public final void addNewPolicy(java.lang.String language,
                               java.net.URI policyUri)

Adds a new scheme policy in a specific language.

Parameters:

language - Language to which add the policy.

policyUri - scheme policy URI to add.

setPolicies

public final void setPolicies(java.util.Map<java.lang.String,java.net.URI> policiesParam)

Sets the value of the attribute policies.

Parameters:

policiesParam - The value for the attribute policies.

isThereSomePolicy

public final boolean isThereSomePolicy()

Checks if there is at least one scheme policy.

Returns:

true if there is, otherwise false.

getLegalNotices

public final java.util.Map<java.lang.String,java.lang.String> getLegalNotices()

Gets the value of the attribute legalNotices.

Returns:

the value of the attribute legalNotices.

getLegalNoticeInLanguage

public final java.lang.String getLegalNoticeInLanguage(java.lang.String language)

Gets the notice from the input language.

Parameters:

language - Language to search (ISO 639).

Returns:

Legal notice for the input language.

addNewLegalNotice

public final void addNewLegalNotice(java.lang.String language,
                                    java.lang.String legalNotice)

Adds a new scheme legal notice in a specific language.

Parameters:

language - Language to which add the legal notice.

legalNotice - legal notice to add.

setLegalNotices

public final void setLegalNotices(java.util.Map<java.lang.String,java.lang.String> legalNoticesParam)

Sets the value of the attribute legalNotices.

Parameters:

legalNoticesParam - The value for the attribute legalNotices.

isThereSomeLegalNotice

public final boolean isThereSomeLegalNotice()

Checks if there is at least one scheme legal notice.

Returns:

true if there is, otherwise false.

getHistoricalPeriod

public final int getHistoricalPeriod()

Gets the value of the attribute historicalPeriod.

Returns:

the value of the attribute historicalPeriod.

setHistoricalPeriod

public final void setHistoricalPeriod(int historicalPeriodParam)

Sets the value of the attribute historicalPeriod.

Parameters:

historicalPeriodParam - The value for the attribute historicalPeriod.

getPointersToOtherTSL

public final java.util.List<TSLPointer> getPointersToOtherTSL()

Gets the value of the attribute pointersToOtherTSL.

Returns:

the value of the attribute pointersToOtherTSL.

addNewPointerToOtherTSL

public final void addNewPointerToOtherTSL(TSLPointer pointer)

Adds a new pointer to other TSL.

Parameters:

pointer - pointer to other TSL object representation.

setPointersToOtherTSL

public final void setPointersToOtherTSL(java.util.List<TSLPointer> pointersToOtherTSLParam)

Sets the value of the attribute pointersToOtherTSL.

Parameters:

pointersToOtherTSLParam - The value for the attribute pointersToOtherTSL.

isThereSomePointerToOtherTSL

public final boolean isThereSomePointerToOtherTSL()

Checks if there is at least one pointer to other TSL.

Returns:

true if there is, otherwise false.

getListIssueDateTime

public final java.util.Date getListIssueDateTime()

Gets the value of the attribute listIssueDateTime.

Returns:

the value of the attribute listIssueDateTime.

setListIssueDateTime

public final void setListIssueDateTime(java.util.Date listIssueDateTimeParam)

Sets the value of the attribute listIssueDateTime.

Parameters:

listIssueDateTimeParam - The value for the attribute listIssueDateTime.

getNextUpdate

public final java.util.Date getNextUpdate()

Gets the value of the attribute nextUpdate.

Returns:

the value of the attribute nextUpdate.

setNextUpdate

public final void setNextUpdate(java.util.Date nextUpdateParam)

Sets the value of the attribute nextUpdate.

Parameters:

nextUpdateParam - The value for the attribute nextUpdate.

getDistributionPoints

public final java.util.List<java.net.URI> getDistributionPoints()

Gets the value of the attribute distributionPoints.

Returns:

the value of the attribute distributionPoints.

addNewDistributionPoint

public final void addNewDistributionPoint(java.net.URI dpUri)

Adds a new distribution point.

Parameters:

dpUri - Distribution point to add.

setDistributionPoints

public final void setDistributionPoints(java.util.List<java.net.URI> distributionPointsParam)

Sets the value of the attribute distributionPoints.

Parameters:

distributionPointsParam - The value for the attribute distributionPoints.

isThereSomeDistributionPoint

public final boolean isThereSomeDistributionPoint()

Checks if there is at least one distribution point.

Returns:

true if there is, otherwise false.

getSchemeInformationExtensions

public final java.util.List<IAnyTypeExtension> getSchemeInformationExtensions()

Gets the value of the attribute schemeInformationExtensions.

Returns:

the value of the attribute schemeInformationExtensions.

addNewSchemeInformationExtension

public final void addNewSchemeInformationExtension(IAnyTypeExtension extension)

Adds a new extension if it is not null.

Parameters:

extension - extension to add.

isThereSomeSchemeInformationExtension

public final boolean isThereSomeSchemeInformationExtension()

Checks if there is at least one scheme information extension.

Returns:

true if there is at least one scheme information extension, otherwise false.