From: Richard Millet Date: Wed, 11 Feb 2009 18:05:14 +0000 (+0000) Subject: Importing wiki->java code X-Git-Url: https://git.aero2k.de/?a=commitdiff_plain;h=37e84a8af410de089763809ce46c3ba4fb6cf9c3;p=tmp%2Fjakarta-migration.git Importing wiki->java code --- diff --git a/sandbox/kss/wiki_to_java/.classpath b/sandbox/kss/wiki_to_java/.classpath new file mode 100644 index 000000000..269c23b24 --- /dev/null +++ b/sandbox/kss/wiki_to_java/.classpath @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/sandbox/kss/wiki_to_java/.factorypath b/sandbox/kss/wiki_to_java/.factorypath new file mode 100644 index 000000000..610dea5ff --- /dev/null +++ b/sandbox/kss/wiki_to_java/.factorypath @@ -0,0 +1,2 @@ + + diff --git a/sandbox/kss/wiki_to_java/.project b/sandbox/kss/wiki_to_java/.project new file mode 100644 index 000000000..f4169a602 --- /dev/null +++ b/sandbox/kss/wiki_to_java/.project @@ -0,0 +1,23 @@ + + + maven-kscontract-plugin + + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.maven.ide.eclipse.maven2Builder + + + + + + org.eclipse.jdt.core.javanature + org.maven.ide.eclipse.maven2Nature + + diff --git a/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.apt.core.prefs b/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.apt.core.prefs new file mode 100644 index 000000000..ba8a488a8 --- /dev/null +++ b/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.apt.core.prefs @@ -0,0 +1,5 @@ +#Mon Jan 26 12:10:34 PST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.apt.aptEnabled=true +org.eclipse.jdt.apt.genSrcDir=.apt_generated +org.eclipse.jdt.apt.reconcileEnabled=true diff --git a/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.core.prefs b/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 000000000..92af791ed --- /dev/null +++ b/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,88 @@ +#Mon Jan 26 12:11:37 PST 2009 +eclipse.preferences.version=1 +org.eclipse.jdt.core.builder.cleanOutputFolder=ignore +org.eclipse.jdt.core.builder.duplicateResourceTask=warning +org.eclipse.jdt.core.builder.invalidClasspath=abort +org.eclipse.jdt.core.builder.recreateModifiedClassFileInOutputFolder=ignore +org.eclipse.jdt.core.builder.resourceCopyExclusionFilter=*.launch +org.eclipse.jdt.core.circularClasspath=error +org.eclipse.jdt.core.classpath.exclusionPatterns=enabled +org.eclipse.jdt.core.classpath.multipleOutputLocations=enabled +org.eclipse.jdt.core.compiler.doc.comment.support=enabled +org.eclipse.jdt.core.compiler.maxProblemPerUnit=100 +org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning +org.eclipse.jdt.core.compiler.problem.autoboxing=ignore +org.eclipse.jdt.core.compiler.problem.deprecation=warning +org.eclipse.jdt.core.compiler.problem.deprecationInDeprecatedCode=disabled +org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled +org.eclipse.jdt.core.compiler.problem.discouragedReference=warning +org.eclipse.jdt.core.compiler.problem.emptyStatement=ignore +org.eclipse.jdt.core.compiler.problem.fallthroughCase=ignore +org.eclipse.jdt.core.compiler.problem.fatalOptionalError=enabled +org.eclipse.jdt.core.compiler.problem.fieldHiding=ignore +org.eclipse.jdt.core.compiler.problem.finalParameterBound=warning +org.eclipse.jdt.core.compiler.problem.finallyBlockNotCompletingNormally=warning +org.eclipse.jdt.core.compiler.problem.forbiddenReference=error +org.eclipse.jdt.core.compiler.problem.hiddenCatchBlock=warning +org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning +org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=ignore +org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore +org.eclipse.jdt.core.compiler.problem.invalidJavadoc=ignore +org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=disabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=disabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=public +org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore +org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning +org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public +org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag +org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=public +org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore +org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning +org.eclipse.jdt.core.compiler.problem.noEffectAssignment=warning +org.eclipse.jdt.core.compiler.problem.noImplicitStringConversion=warning +org.eclipse.jdt.core.compiler.problem.nonExternalizedStringLiteral=ignore +org.eclipse.jdt.core.compiler.problem.nullReference=warning +org.eclipse.jdt.core.compiler.problem.overridingPackageDefaultMethod=warning +org.eclipse.jdt.core.compiler.problem.parameterAssignment=ignore +org.eclipse.jdt.core.compiler.problem.possibleAccidentalBooleanAssignment=ignore +org.eclipse.jdt.core.compiler.problem.potentialNullReference=ignore +org.eclipse.jdt.core.compiler.problem.rawTypeReference=warning +org.eclipse.jdt.core.compiler.problem.redundantNullCheck=ignore +org.eclipse.jdt.core.compiler.problem.redundantSuperinterface=ignore +org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled +org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning +org.eclipse.jdt.core.compiler.problem.suppressWarnings=enabled +org.eclipse.jdt.core.compiler.problem.syntheticAccessEmulation=ignore +org.eclipse.jdt.core.compiler.problem.typeParameterHiding=warning +org.eclipse.jdt.core.compiler.problem.uncheckedTypeOperation=warning +org.eclipse.jdt.core.compiler.problem.undocumentedEmptyBlock=ignore +org.eclipse.jdt.core.compiler.problem.unhandledWarningToken=warning +org.eclipse.jdt.core.compiler.problem.unnecessaryElse=ignore +org.eclipse.jdt.core.compiler.problem.unnecessaryTypeCheck=ignore +org.eclipse.jdt.core.compiler.problem.unqualifiedFieldAccess=ignore +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=ignore +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionExemptExceptionAndThrowable=enabled +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionIncludeDocCommentReference=enabled +org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=disabled +org.eclipse.jdt.core.compiler.problem.unusedImport=warning +org.eclipse.jdt.core.compiler.problem.unusedLabel=warning +org.eclipse.jdt.core.compiler.problem.unusedLocal=warning +org.eclipse.jdt.core.compiler.problem.unusedParameter=ignore +org.eclipse.jdt.core.compiler.problem.unusedParameterIncludeDocCommentReference=enabled +org.eclipse.jdt.core.compiler.problem.unusedParameterWhenImplementingAbstract=disabled +org.eclipse.jdt.core.compiler.problem.unusedParameterWhenOverridingConcrete=disabled +org.eclipse.jdt.core.compiler.problem.unusedPrivateMember=warning +org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning +org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning +org.eclipse.jdt.core.compiler.processAnnotations=enabled +org.eclipse.jdt.core.compiler.taskCaseSensitive=enabled +org.eclipse.jdt.core.compiler.taskPriorities=NORMAL,HIGH,NORMAL +org.eclipse.jdt.core.compiler.taskTags=TODO,FIXME,XXX +org.eclipse.jdt.core.incompatibleJDKLevel=ignore +org.eclipse.jdt.core.incompleteClasspath=error diff --git a/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.ui.prefs b/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.ui.prefs new file mode 100644 index 000000000..4918a426b --- /dev/null +++ b/sandbox/kss/wiki_to_java/.settings/org.eclipse.jdt.ui.prefs @@ -0,0 +1,4 @@ +#Mon Jan 26 12:10:31 PST 2009 +eclipse.preferences.version=1 +internal.default.compliance=user +org.eclipse.jdt.ui.text.custom_code_templates= diff --git a/sandbox/kss/wiki_to_java/.settings/org.maven.ide.eclipse.prefs b/sandbox/kss/wiki_to_java/.settings/org.maven.ide.eclipse.prefs new file mode 100644 index 000000000..db1a996d4 --- /dev/null +++ b/sandbox/kss/wiki_to_java/.settings/org.maven.ide.eclipse.prefs @@ -0,0 +1,10 @@ +#Mon Jan 26 12:05:24 PST 2009 +activeProfiles= +eclipse.preferences.version=1 +filterResources=false +fullBuildGoals=process-test-resources +includeModules=false +resolveWorkspaceProjects=true +resourceFilterGoals=process-resources resources\:testResources +useMavenFolders=true +version=1 diff --git a/sandbox/kss/wiki_to_java/contracts/New Text Document.xml b/sandbox/kss/wiki_to_java/contracts/New Text Document.xml new file mode 100644 index 000000000..626ceb1d8 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/New Text Document.xml @@ -0,0 +1,295 @@ + + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindFactTypes
DescriptionRetrieves the list of Facts Types known by this service.
ParametersNoneNoneNo parameters
ReturnfactTypeInfoListList of Fact type information Do we want to switch this to just keys due to amount of information?
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchFactType
DescriptionRetrieves information about a type of Fact, listing all the keys required for its computation.
ParametersfactTypeKeyfactTypeKeyIdentifier for the Fact type.
ReturnfactTypeInfoInformation about the specified type of Fact
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Read

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindFact
Descriptionretrieves the result of computation of the Fact by the service
ParametersfactTypeKeyfactTypeKeyFact type idenfifier
factStructurefactStructureFact Structure containing Fact type and values for the keys required for fact computation.
ReturnfactResultsvalues for the fact that will be used in the rules - differentiated from normal search results, due to potential differing needs (ex. inclusion of the resultType in expanded form, etc.) Probably need to discuss
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + +
+
+

Labels

+ Edit + +
+ +
+
+
+ kss-rules kss-rules + Delete +
+
+ + kss-svcs kss-svcs + Delete +
+
+ kss-service kss-service + Delete + +
+
+ kss-svb2 kss-svb2 + Delete +
+
+ + +
+ +
+ + +
Enter labels to add to this page:
+ + + + + +
+ Please wait  + +
+
+
+
+ Looking for a label? Just start typing. +
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ Add Comment +

+
+ + + + + + + + + + + + +
diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/cspace/getCommMediaTypesForUsageType.html.xml b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/getCommMediaTypesForUsageType.html.xml new file mode 100644 index 000000000..083cf2401 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/getCommMediaTypesForUsageType.html.xml @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage type identifier
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/cspace/old/getCommMediaTypesForUsageType.html.xml b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/old/getCommMediaTypesForUsageType.html.xml new file mode 100644 index 000000000..4705a14f6 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/old/getCommMediaTypesForUsageType.html.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage type identifier
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/cspace/old/getCommMediaTypesForUsageType.trimmed.xml b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/old/getCommMediaTypesForUsageType.trimmed.xml new file mode 100644 index 000000000..3c8c0e3f1 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/old/getCommMediaTypesForUsageType.trimmed.xml @@ -0,0 +1 @@ +
MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
Parameters[commUsageTypeKey]commUsageTypeKeyusage type identifier
Return[commMediaTypeInfoList]list of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/cspace/v1.getCommMediaTypesForUsageType.trimmed.xml b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/v1.getCommMediaTypesForUsageType.trimmed.xml new file mode 100644 index 000000000..811acf241 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/v1.getCommMediaTypesForUsageType.trimmed.xml @@ -0,0 +1,99 @@ + +


Back to Operations +

+


Back to Operations

+

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage type identifier
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+ +

+Back to Operations +

+ +

+ +Read +

+ +

Back to Operations

+

+ +Search +

+ +

Back to Operations

+

+ +Maintenance +

+ +


Back to Operations

+


Back to Operations

+


Back to Operations

+


Back to Operations

+


Back to Operations

+

+ +

Capabilities

+

diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/cspace/v2.getCommMediaTypesForUsageType.trimmed.xml b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/v2.getCommMediaTypesForUsageType.trimmed.xml new file mode 100644 index 000000000..c83402ce5 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/cspace/v2.getCommMediaTypesForUsageType.trimmed.xml @@ -0,0 +1 @@ +


Back to Operations


Back to Operations

MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage type identifier
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

Read

Back to Operations

Search

Back to Operations

Maintenance


Back to Operations


Back to Operations


Back to Operations


Back to Operations


Back to Operations

diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.html.xml b/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.html.xml new file mode 100644 index 000000000..8e1fdbef3 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.html.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage type identifier
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.trimmed.xml b/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.trimmed.xml new file mode 100644 index 000000000..67582ce7e --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.trimmed.xml @@ -0,0 +1,27 @@ +
MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list +of communication media types that are supported for a given usage +type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage +type identifier
ReturncommMediaTypeInfoListlist of communication media type +information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.trimmed.xml.bak b/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.trimmed.xml.bak new file mode 100644 index 000000000..3bfa96a57 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/To Print/kss/getCommMediaTypesForUsageType.trimmed.xml.bak @@ -0,0 +1 @@ +
MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage type identifier
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
diff --git a/sandbox/kss/wiki_to_java/contracts/To Print/kss/kss_communication_service.html.xml b/sandbox/kss/wiki_to_java/contracts/To Print/kss/kss_communication_service.html.xml new file mode 100644 index 000000000..e69de29bb diff --git a/sandbox/kss/wiki_to_java/contracts/comservice.trimmed.html.xml b/sandbox/kss/wiki_to_java/contracts/comservice.trimmed.html.xml new file mode 100644 index 000000000..8397ccea4 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/comservice.trimmed.html.xml @@ -0,0 +1 @@ +

MethodgetCommMediaTypes
DescriptionRetrieves the list of communication media types that this service knows of.
ParametersNoneNoneNo parameters
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodgetCommUsageTypes
DescriptionRetrieves the list of communication usage types that this service knows of.
ParametersNoneNoneNo parameters
ReturncommUsageTypeInfoListlist of communication usage type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodgetCommMediaTypesForUsageType
DescriptionRetrieves the list of communication media types that are supported for a given usage type.
ParameterscommUsageTypeKeycommUsageTypeKeyusage type identifier
ReturncommMediaTypeInfoListlist of communication media type information
ErrorsDOES_NOT_EXISTcommUsageTypeKey not found
INVALID_PARAMETERinvalid commUsageTypeKey
MISSING_PARAMETERmissing commUsageTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

Read

Back to Operations

Search

Back to Operations

Maintenance

MethodsendMessageToPeople
DescriptionSends a message to a list of people for a particular media and usage type
ParameterspersonIdListpersonIdListlist of person identifiers
commMediaTypeKeycommMediaTypeKeymedia type identifier
commUsageTypeKeycommUsageTypeKeyusage type identifier
stringsubjectsubject of the message
stringmessagemessage to send
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId found, but has been retired
DOES_NOT_EXISTpersonId, commMediaTypeKey, commUsageTypeKey not found
INVALID_PARAMETERinvalid personId, commMediaTypeKey, commUsageTypeKey, subject, message
MISSING_PARAMETERmissing personId, commMediaTypeKey, commUsageTypeKey, subject, message
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED_ACTIONcommMediaTypeKey is not supported for the commUsageTypeKey
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodsendMessageToPeopleByUsageType
DescriptionSends a message to a list of people for a particular usage type
ParameterspersonIdListpersonIdListlist of person identifiers
commUsageTypeKeycommUsageTypeKeyusage type identifier
stringsubjectsubject of the message
stringmessagemessage to send
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId found, but has been retired
DOES_NOT_EXISTpersonId, commUsageTypeKey not found
INVALID_PARAMETERinvalid personId, commUsageTypeKey, subject, message
MISSING_PARAMETERmissing personId, commUsageTypeKey, subject, message
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodsendMessageToPeopleByMediaType
DescriptionSends a message to a list of people for a particular media type
ParameterspersonIdListpersonIdListlist of person identifiers
commMediaTypeKeycommMediaTypeKeymedia type identifier
stringsubjectsubject of the message
stringmessagemessage to send
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId found, but has been retired
DOES_NOT_EXISTpersonId, commMediaTypeKey not found
INVALID_PARAMETERinvalid personIdList, commMediaTypeKey, subject, message
MISSING_PARAMETERmissing personIdList, commMediaTypeKey, subject, message
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodsendMessageToOrg
DescriptionSends a message to an organization for a particular media and usage type
ParametersorgIdListorgIdListlist of organization identifiers
commMediaTypeKeycommMediaTypeKeymedia type identifier
commUsageTypeKeycommUsageTypeKeyusage type identifier
stringsubjectsubject of the message
stringmessagemessage to send
Returnstatusstatus of the operation
ErrorsDOES_NOT_EXISTorgId, commMediaTypeKey, commUsageTypeKey not found
INVALID_PARAMETERinvalid orgIdList, commMediaTypeKey, commUsageTypeKey, subject, message
MISSING_PARAMETERmissing orgIdList, commMediaTypeKey, commUsageTypeKey, subject, message
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED_ACTIONcommMediaTypeKey is not supported for the commUsageTypeKey
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodsendMessageToOrgByUsageType
DescriptionSends a message to an organization for a particular usage type
ParametersorgIdListorgIdListlist of organization identifier
commUsageTypeKeycommUsageTypeKeyusage type identifier
stringsubjectsubject of the message
stringmessagemessage to send
Returnstatusstatus of the operation
ErrorsDOES_NOT_EXISTorgId, commUsageTypeKey not found
INVALID_PARAMETERinvalid orgIdList, commUsageTypeKey, subject, message
MISSING_PARAMETERmissing orgIdList, commUsageTypeKey, subject, message
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

diff --git a/sandbox/kss/wiki_to_java/contracts/ffservice b/sandbox/kss/wiki_to_java/contracts/ffservice new file mode 100644 index 000000000..8e5061b9b --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/ffservice @@ -0,0 +1,930 @@ + + + + Fact Finder Service - KS Workspace - Confluence + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

+ + + Fact Finder Service + +

+ + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ +

Fact Finder Service

+ + + + + + + + + + + + +
NameFactFinderService
VersionDevRelease Notes/History
+ + + + + + + +
References Operations Capabilities
+ +

References

+ +

Fact Finder Service Description and Assumptions
+Business Rules Management Service Description and Assumptions
+BRMS Entity Diagram - diagram used in the creation of BRMS
+ +BRMS Core Technical Entity Diagram
+BRMS Design Specification
+BRMS stack describes the relationship between the BRMS and the run-time rules engine (Drools)
+BRMS Structures

+ +

Operations

+ + + +
+
+Setup +
+ + +
+ +
Read
+ +

+ +

Setup

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindFactTypes
DescriptionRetrieves the list of Facts Types known by this service.
ParametersNoneNoneNo parameters
ReturnfactTypeInfoListList of Fact type information Do we want to switch this to just keys due to amount of information?
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchFactType
DescriptionRetrieves information about a type of Fact, listing all the keys required for its computation.
ParametersfactTypeKeyfactTypeKeyIdentifier for the Fact type.
ReturnfactTypeInfoInformation about the specified type of Fact
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Read

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindFact
Descriptionretrieves the result of computation of the Fact by the service
ParametersfactTypeKeyfactTypeKeyFact type idenfifier
factStructurefactStructureFact Structure containing Fact type and values for the keys required for fact computation.
ReturnfactResultsvalues for the fact that will be used in the rules - differentiated from normal search results, due to potential differing needs (ex. inclusion of the resultType in expanded form, etc.) Probably need to discuss
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ +

Capabilities

+
+ + + + + + + + + + + + + +
+
+

Labels

+ Edit + +
+ +
+
+
+ kss-rules kss-rules + Delete +
+
+ + kss-svcs kss-svcs + Delete +
+
+ kss-service kss-service + Delete + +
+
+ kss-svb2 kss-svb2 + Delete +
+
+ + +
+ +
+ + +
Enter labels to add to this page:
+ + + + + +
+ Please wait  + +
+
+
+
+ Looking for a label? Just start typing. +
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ Add Comment +

+
+ + + + +
+
+ + + + + + diff --git a/sandbox/kss/wiki_to_java/contracts/ffservice.bak b/sandbox/kss/wiki_to_java/contracts/ffservice.bak new file mode 100644 index 000000000..e22f43358 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/ffservice.bak @@ -0,0 +1,921 @@ + + + + Fact Finder Service - KS Workspace - Confluence + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

+ + + Fact Finder Service + +

+ + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ +

Fact Finder Service

+ + + + + + + + + + + + +
NameFactFinderService
VersionDevRelease Notes/History
+ + + + + + + +
References Operations Capabilities
+ +

References

+ +

Fact Finder Service Description and Assumptions
+Business Rules Management Service Description and Assumptions
+BRMS Entity Diagram - diagram used in the creation of BRMS
+ +BRMS Core Technical Entity Diagram
+BRMS Design Specification
+BRMS stack describes the relationship between the BRMS and the run-time rules engine (Drools)
+BRMS Structures

+ +

Operations

+ + + + + +
Read
+ +

+ +

Setup

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindFactTypes
DescriptionRetrieves the list of Facts Types known by this service.
ParametersNoneNoneNo parameters
ReturnfactTypeInfoListList of Fact type information Do we want to switch this to just keys due to amount of information?
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchFactType
DescriptionRetrieves information about a type of Fact, listing all the keys required for its computation.
ParametersfactTypeKeyfactTypeKeyIdentifier for the Fact type.
ReturnfactTypeInfoInformation about the specified type of Fact
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Read

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindFact
Descriptionretrieves the result of computation of the Fact by the service
ParametersfactTypeKeyfactTypeKeyFact type idenfifier
factStructurefactStructureFact Structure containing Fact type and values for the keys required for fact computation.
ReturnfactResultsvalues for the fact that will be used in the rules - differentiated from normal search results, due to potential differing needs (ex. inclusion of the resultType in expanded form, etc.) Probably need to discuss
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+
+ + + + + + + + + + + + + +
+
+

Labels

+ Edit + +
+ +
+
+
+ kss-rules kss-rules + Delete +
+
+ + kss-svcs kss-svcs + Delete +
+
+ kss-service kss-service + Delete + +
+
+ kss-svb2 kss-svb2 + Delete +
+
+ + +
+ +
+ + +
Enter labels to add to this page:
+ + + + + +
+ Please wait  + +
+
+
+
+ Looking for a label? Just start typing. +
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ Add Comment +

+
+ + + + +
+
+ + + + + + diff --git a/sandbox/kss/wiki_to_java/contracts/kss.trimmed.xml b/sandbox/kss/wiki_to_java/contracts/kss.trimmed.xml new file mode 100644 index 000000000..308b3fc40 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/kss.trimmed.xml @@ -0,0 +1 @@ +

MethodfindObjectTypes
DescriptionRetrieves the list of object type identifiers known by this service. Example: cluInfo.
ParametersNoneNoneNo parameters
ReturnobjectTypeKeyListlist of object type identifiers
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchObjectStructure
DescriptionRetrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc.
ParametersobjectTypeKeyobjectTypeKeyidentifier of the object type
ReturnobjectStructuredescribes the fields for the input object type
ErrorsDOES_NOT_EXISTspecified objectTypeKey not found
INVALID_PARAMETERinvalid objectTypeKey
MISSING_PARAMETERmissing objectTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchEnumeration
DescriptionRetrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.
ParametersenumerationKeyenumerationKeyidentifier of the enumeration
enumContextKeycontextTypeidentifier of the enumeration context type
stringcontextValuevalue of the enumeration context
dateTimecontextDatedate and time to get the enumeration for
ReturnenumeratedValueListlist of enumerated codes and values
ErrorsDOES_NOT_EXISTenumerationKey not found
INVALID_PARAMETERinvalid enumerationKey, contextType, contextValue, contextDate
MISSING_PARAMETERmissing enumerationKey, contextType, contextValue, contextDate
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindSearchTypes
DescriptionRetrieves the list of search types known by this service.
ParametersNoneNoneNo Parameters
ReturnsearchTypeInfoListlist of search type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchSearchType
DescriptionRetrieves information about a particular search type.
ParameterssearchTypeKeysearchTypeKeyidentifier of the search type
ReturnsearchTypeInfoinformation on the search type
ErrorsDOES_NOT_EXISTspecified searchTypeKey not found
INVALID_PARAMETERinvalid searchTypeKey
MISSING_PARAMETERsearchTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindSearchTypesByResult
DescriptionRetrieves the list of search types which return results in the specified format.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindSearchTypesByCriteria
DescriptionRetrieves the list of search types which use criteria in the specified format.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindSearchResultTypes
DescriptionRetrieves the list of search result types known by this service. Search result types describe the return structure for a search.
ParametersNoneNoneNo Parameters
ReturnsearchResultTypeInfoListlist of search result type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchSearchResultType
DescriptionRetrieves information about a particular search result type. Search result types describe the return structure for a search.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchResultTypeInfoinformation on the search result type
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindSearchCriteriaTypes
DescriptionRetrieves the list of search criteria types known by this service.
ParametersNoneNoneNo parameters
ReturnsearchCriteriaTypeInfoListlist of search criteria type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchSearchCriteriaType
DescriptionRetrieves information about a particular search criteria type.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria type
ReturnsearchCriteriaTypeInfoinformation on the search criteria type
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindAuthenticationTypes
DescriptionRetrieve the list of authentication types known by this service
ParametersNoneNoneNo parameters
ReturnauthenticationTypeListlist of authentication types
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
Back to Operations

Read

MethodfindPrincipalIdsByPerson
DescriptionRetrieves a list of Principals for a given Person
ParameterspersonIdpersonIdperson identifier
ReturnprincipalIdListlist of principal ids for the specified person
ErrorsDISABLED_IDENTIFIERpersonId found but has been retired
DOES_NOT_EXISTpersonId not found
INVALID_PARAMETERinvalid personId
MISSING_PARAMETERmissing personId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindPrincipalIdsBySystem
DescriptionRetrieves a list of Principals for a given System
ParameterssystemIdsystemIdsystem identifier
ReturnprincipalIdListlist of principal ids for the given system
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid systemId
MISSING_PARAMETERmissing systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchPersonIdByPrincipal
DescriptionRetrieves a Person for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnpersonIdperson identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchSystemByPrincipal
DescriptionRetrieves a System for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnsystemIdsystem identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfetchPrincipalTypeForPrincipal
DescriptionRetrieves a Principal Type for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnprincipalTypeprincipal type that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodfindPrincipalTypesByPrincipalIdList
DescriptionRetrieves a list of Principal Types for a given list of Principal Ids
ParametersprincipalIdListprincipalIdListlist of principal identifiers
ReturnprincipalTypeListList of principal types that match the supplied criteria
ErrorsDISABLED_IDENTIFIEROne or more principalIds found but have been retired
DOES_NOT_EXISTOne or more principalIds not found
INVALID_PARAMETERinvalid principalIdList
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

Search

MethodsearchForResults
DescriptionRetrieves results in tabular form for the specified parameters.
Parameters[searchTypeKey]searchTypeKeysearch identifier
[queryParamValueList]queryParamValueslist of values for search parameters
Return[resultList]list of results from the query
ErrorsDOES_NOT_EXISTspecified search type not found
INVALID_PARAMETERinvalid searchTypeKey, queryParamValueList
MISSING_PARAMETERsearchTypeKey, queryParamValueList not specified
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

Maintenance

MethodassignPrincipalToPerson
DescriptionAssigns a Principal to a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodassignPrincipalToSystem
DescriptionAssigns a Principal to a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodremovePrincipalFromPerson
DescriptionRemove a Principal from a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId, association does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

MethodremovePrincipalFromSystem
DescriptionRemove a Principal from a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId, association does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
Back to Operations

\ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/contracts/servicetemplate b/sandbox/kss/wiki_to_java/contracts/servicetemplate new file mode 100644 index 000000000..5321d4e1e --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/servicetemplate @@ -0,0 +1,1281 @@ +

+ +

Setup

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindObjectTypes
DescriptionRetrieves the list of object type identifiers known by this service. Example: cluInfo.
ParametersNoneNoneNo parameters
ReturnobjectTypeKeyListlist of object type identifiers
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchObjectStructure
DescriptionRetrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc.
ParametersobjectTypeKeyobjectTypeKeyidentifier of the object type
ReturnobjectStructuredescribes the fields for the input object type
ErrorsDOES_NOT_EXISTspecified objectTypeKey not found
INVALID_PARAMETERinvalid objectTypeKey
MISSING_PARAMETERmissing objectTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchEnumeration
DescriptionRetrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.
ParametersenumerationKeyenumerationKeyidentifier of the enumeration
enumContextKeycontextTypeidentifier of the enumeration context type
stringcontextValuevalue of the enumeration context
dateTimecontextDatedate and time to get the enumeration for
ReturnenumeratedValueListlist of enumerated codes and values
ErrorsDOES_NOT_EXISTenumerationKey not found
INVALID_PARAMETERinvalid enumerationKey, contextType, contextValue, contextDate
MISSING_PARAMETERmissing enumerationKey, contextType, contextValue, contextDate
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypes
DescriptionRetrieves the list of search types known by this service.
ParametersNoneNoneNo Parameters
ReturnsearchTypeInfoListlist of search type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchType
DescriptionRetrieves information about a particular search type.
ParameterssearchTypeKeysearchTypeKeyidentifier of the search type
ReturnsearchTypeInfoinformation on the search type
ErrorsDOES_NOT_EXISTspecified searchTypeKey not found
INVALID_PARAMETERinvalid searchTypeKey
MISSING_PARAMETERsearchTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypesByResult
DescriptionRetrieves the list of search types which return results in the specified format.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypesByCriteria
DescriptionRetrieves the list of search types which use criteria in the specified format.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchResultTypes
DescriptionRetrieves the list of search result types known by this service. Search result types describe the return structure for a search.
ParametersNoneNoneNo Parameters
ReturnsearchResultTypeInfoListlist of search result type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchResultType
DescriptionRetrieves information about a particular search result type. Search result types describe the return structure for a search.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchResultTypeInfoinformation on the search result type
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchCriteriaTypes
DescriptionRetrieves the list of search criteria types known by this service.
ParametersNoneNoneNo parameters
ReturnsearchCriteriaTypeInfoListlist of search criteria type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchCriteriaType
DescriptionRetrieves information about a particular search criteria type.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria type
ReturnsearchCriteriaTypeInfoinformation on the search criteria type
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindAuthenticationTypes
DescriptionRetrieve the list of authentication types known by this service
ParametersNoneNoneNo parameters
ReturnauthenticationTypeListlist of authentication types
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Read

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalIdsByPerson
DescriptionRetrieves a list of Principals for a given Person
ParameterspersonIdpersonIdperson identifier
ReturnprincipalIdListlist of principal ids for the specified person
ErrorsDISABLED_IDENTIFIERpersonId found but has been retired
DOES_NOT_EXISTpersonId not found
INVALID_PARAMETERinvalid personId
MISSING_PARAMETERmissing personId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalIdsBySystem
DescriptionRetrieves a list of Principals for a given System
ParameterssystemIdsystemIdsystem identifier
ReturnprincipalIdListlist of principal ids for the given system
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid systemId
MISSING_PARAMETERmissing systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchPersonIdByPrincipal
DescriptionRetrieves a Person for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnpersonIdperson identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSystemByPrincipal
DescriptionRetrieves a System for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnsystemIdsystem identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchPrincipalTypeForPrincipal
DescriptionRetrieves a Principal Type for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnprincipalTypeprincipal type that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalTypesByPrincipalIdList
DescriptionRetrieves a list of Principal Types for a given list of Principal Ids
ParametersprincipalIdListprincipalIdListlist of principal identifiers
ReturnprincipalTypeListList of principal types that match the supplied criteria
ErrorsDISABLED_IDENTIFIEROne or more principalIds found but have been retired
DOES_NOT_EXISTOne or more principalIds not found
INVALID_PARAMETERinvalid principalIdList
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Search

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodsearchForResults
DescriptionRetrieves results in tabular form for the specified parameters.
ParameterssearchTypeKeysearchTypeKeysearch identifier
queryParamValueListqueryParamValueslist of values for search parameters
ReturnresultListlist of results from the query
ErrorsDOES_NOT_EXISTspecified search type not found
INVALID_PARAMETERinvalid searchTypeKey, queryParamValueList
MISSING_PARAMETERsearchTypeKey, queryParamValueList not specified
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Maintenance

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodassignPrincipalToPerson
DescriptionAssigns a Principal to a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodassignPrincipalToSystem
DescriptionAssigns a Principal to a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodremovePrincipalFromPerson
DescriptionRemove a Principal from a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId, association does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodremovePrincipalFromSystem
DescriptionRemove a Principal from a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId, association does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ +

Capabilities

+ + + + + + + + + + + + + + +
+
+

Labels

+ + Edit + +
+ +
+
+
+ + kss-svcs kss-svcs + Delete +
+
+ kss-pi kss-pi + Delete + +
+
+ kss-service kss-service + Delete +
+
+ kss-svb1 kss-svb1 + + Delete +
+
+ + +
+
+ + +
Enter labels to add to this page:
+ + + + +
+ Please wait  + + +
+
+
+
+ Looking for a label? Just start typing. +
+
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ Add Comment +

+
+ + + + + + + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/contracts/servicetemplate.bak b/sandbox/kss/wiki_to_java/contracts/servicetemplate.bak new file mode 100644 index 000000000..5b0ab97c3 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/servicetemplate.bak @@ -0,0 +1,1965 @@ + + + + Authentication Service - KS Workspace - Confluence + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

+ + + Authentication Service + +

+ + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ +

Authentication Service

+ + + + + + + + + + + + +
NameAuthenticationService
VersionDevRelease Notes/History
+ + + + + + + +
References Operations Capabilities
+ +


+
Authentication Service Description and Assumptions
+This service establishes identity only. It may also provide a mapping from the identity "Principal" to the Person_Id. +
+ +
Notes
+ +
+ +

References

+ +

Authentication Service Description and Assumptions
+Authentication Service Structures

+ +

Principal Entity and Principal Set Entity - entity page with fields and examples.
+ +Authentication Stack Options - help understand how the Authentication service might interact with other service layers
+PI Meeting Diagrams

+ +

Operations

+ + + + + + + + + +
Maintenance
+ +

assignPrincipalToPerson
+assignPrincipalToSystem Changed Service to System
+removePrincipalFromPerson
+removePrincipalFromSystem Changed Service to System

+
+ +

+ +

Setup

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindObjectTypes
DescriptionRetrieves the list of object type identifiers known by this service. Example: cluInfo.
ParametersNoneNoneNo parameters
ReturnobjectTypeKeyListlist of object type identifiers
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchObjectStructure
DescriptionRetrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc.
ParametersobjectTypeKeyobjectTypeKeyidentifier of the object type
ReturnobjectStructuredescribes the fields for the input object type
ErrorsDOES_NOT_EXISTspecified objectTypeKey not found
INVALID_PARAMETERinvalid objectTypeKey
MISSING_PARAMETERmissing objectTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchEnumeration
DescriptionRetrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.
ParametersenumerationKeyenumerationKeyidentifier of the enumeration
enumContextKeycontextTypeidentifier of the enumeration context type
stringcontextValuevalue of the enumeration context
dateTimecontextDatedate and time to get the enumeration for
ReturnenumeratedValueListlist of enumerated codes and values
ErrorsDOES_NOT_EXISTenumerationKey not found
INVALID_PARAMETERinvalid enumerationKey, contextType, contextValue, contextDate
MISSING_PARAMETERmissing enumerationKey, contextType, contextValue, contextDate
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypes
DescriptionRetrieves the list of search types known by this service.
ParametersNoneNoneNo Parameters
ReturnsearchTypeInfoListlist of search type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchType
DescriptionRetrieves information about a particular search type.
ParameterssearchTypeKeysearchTypeKeyidentifier of the search type
ReturnsearchTypeInfoinformation on the search type
ErrorsDOES_NOT_EXISTspecified searchTypeKey not found
INVALID_PARAMETERinvalid searchTypeKey
MISSING_PARAMETERsearchTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypesByResult
DescriptionRetrieves the list of search types which return results in the specified format.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypesByCriteria
DescriptionRetrieves the list of search types which use criteria in the specified format.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchResultTypes
DescriptionRetrieves the list of search result types known by this service. Search result types describe the return structure for a search.
ParametersNoneNoneNo Parameters
ReturnsearchResultTypeInfoListlist of search result type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchResultType
DescriptionRetrieves information about a particular search result type. Search result types describe the return structure for a search.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchResultTypeInfoinformation on the search result type
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchCriteriaTypes
DescriptionRetrieves the list of search criteria types known by this service.
ParametersNoneNoneNo parameters
ReturnsearchCriteriaTypeInfoListlist of search criteria type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchCriteriaType
DescriptionRetrieves information about a particular search criteria type.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria type
ReturnsearchCriteriaTypeInfoinformation on the search criteria type
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindAuthenticationTypes
DescriptionRetrieve the list of authentication types known by this service
ParametersNoneNoneNo parameters
ReturnauthenticationTypeListlist of authentication types
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Read

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalIdsByPerson
DescriptionRetrieves a list of Principals for a given Person
ParameterspersonIdpersonIdperson identifier
ReturnprincipalIdListlist of principal ids for the specified person
ErrorsDISABLED_IDENTIFIERpersonId found but has been retired
DOES_NOT_EXISTpersonId not found
INVALID_PARAMETERinvalid personId
MISSING_PARAMETERmissing personId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalIdsBySystem
DescriptionRetrieves a list of Principals for a given System
ParameterssystemIdsystemIdsystem identifier
ReturnprincipalIdListlist of principal ids for the given system
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid systemId
MISSING_PARAMETERmissing systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchPersonIdByPrincipal
DescriptionRetrieves a Person for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnpersonIdperson identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSystemByPrincipal
DescriptionRetrieves a System for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnsystemIdsystem identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchPrincipalTypeForPrincipal
DescriptionRetrieves a Principal Type for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnprincipalTypeprincipal type that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalTypesByPrincipalIdList
DescriptionRetrieves a list of Principal Types for a given list of Principal Ids
ParametersprincipalIdListprincipalIdListlist of principal identifiers
ReturnprincipalTypeListList of principal types that match the supplied criteria
ErrorsDISABLED_IDENTIFIEROne or more principalIds found but have been retired
DOES_NOT_EXISTOne or more principalIds not found
INVALID_PARAMETERinvalid principalIdList
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Search

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodsearchForResults
DescriptionRetrieves results in tabular form for the specified parameters.
ParameterssearchTypeKeysearchTypeKeysearch identifier
queryParamValueListqueryParamValueslist of values for search parameters
ReturnresultListlist of results from the query
ErrorsDOES_NOT_EXISTspecified search type not found
INVALID_PARAMETERinvalid searchTypeKey, queryParamValueList
MISSING_PARAMETERsearchTypeKey, queryParamValueList not specified
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Maintenance

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodassignPrincipalToPerson
DescriptionAssigns a Principal to a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodassignPrincipalToSystem
DescriptionAssigns a Principal to a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodremovePrincipalFromPerson
DescriptionRemove a Principal from a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId, association does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodremovePrincipalFromSystem
DescriptionRemove a Principal from a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId, association does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ +

Capabilities

+
+ + + + + + + + + + + + + +
+
+

Labels

+ + Edit + +
+ +
+
+
+ + kss-svcs kss-svcs + Delete +
+
+ kss-pi kss-pi + Delete + +
+
+ kss-service kss-service + Delete +
+
+ kss-svb1 kss-svb1 + + Delete +
+
+ + +
+
+ + +
Enter labels to add to this page:
+ + + + +
+ Please wait  + + +
+
+
+
+ Looking for a label? Just start typing. +
+
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ Add Comment +

+
+ + + +
+
+ + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/contracts/servicetemplate.old b/sandbox/kss/wiki_to_java/contracts/servicetemplate.old new file mode 100644 index 000000000..5b0ab97c3 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/servicetemplate.old @@ -0,0 +1,1965 @@ + + + + Authentication Service - KS Workspace - Confluence + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

+ + + Authentication Service + +

+ + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ +

Authentication Service

+ + + + + + + + + + + + +
NameAuthenticationService
VersionDevRelease Notes/History
+ + + + + + + +
References Operations Capabilities
+ +


+
Authentication Service Description and Assumptions
+This service establishes identity only. It may also provide a mapping from the identity "Principal" to the Person_Id. +
+ +
Notes
+ +
+ +

References

+ +

Authentication Service Description and Assumptions
+Authentication Service Structures

+ +

Principal Entity and Principal Set Entity - entity page with fields and examples.
+ +Authentication Stack Options - help understand how the Authentication service might interact with other service layers
+PI Meeting Diagrams

+ +

Operations

+ + + + + + + + + +
Maintenance
+ +

assignPrincipalToPerson
+assignPrincipalToSystem Changed Service to System
+removePrincipalFromPerson
+removePrincipalFromSystem Changed Service to System

+
+ +

+ +

Setup

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindObjectTypes
DescriptionRetrieves the list of object type identifiers known by this service. Example: cluInfo.
ParametersNoneNoneNo parameters
ReturnobjectTypeKeyListlist of object type identifiers
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchObjectStructure
DescriptionRetrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc.
ParametersobjectTypeKeyobjectTypeKeyidentifier of the object type
ReturnobjectStructuredescribes the fields for the input object type
ErrorsDOES_NOT_EXISTspecified objectTypeKey not found
INVALID_PARAMETERinvalid objectTypeKey
MISSING_PARAMETERmissing objectTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchEnumeration
DescriptionRetrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.
ParametersenumerationKeyenumerationKeyidentifier of the enumeration
enumContextKeycontextTypeidentifier of the enumeration context type
stringcontextValuevalue of the enumeration context
dateTimecontextDatedate and time to get the enumeration for
ReturnenumeratedValueListlist of enumerated codes and values
ErrorsDOES_NOT_EXISTenumerationKey not found
INVALID_PARAMETERinvalid enumerationKey, contextType, contextValue, contextDate
MISSING_PARAMETERmissing enumerationKey, contextType, contextValue, contextDate
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypes
DescriptionRetrieves the list of search types known by this service.
ParametersNoneNoneNo Parameters
ReturnsearchTypeInfoListlist of search type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchType
DescriptionRetrieves information about a particular search type.
ParameterssearchTypeKeysearchTypeKeyidentifier of the search type
ReturnsearchTypeInfoinformation on the search type
ErrorsDOES_NOT_EXISTspecified searchTypeKey not found
INVALID_PARAMETERinvalid searchTypeKey
MISSING_PARAMETERsearchTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypesByResult
DescriptionRetrieves the list of search types which return results in the specified format.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchTypesByCriteria
DescriptionRetrieves the list of search types which use criteria in the specified format.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchResultTypes
DescriptionRetrieves the list of search result types known by this service. Search result types describe the return structure for a search.
ParametersNoneNoneNo Parameters
ReturnsearchResultTypeInfoListlist of search result type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchResultType
DescriptionRetrieves information about a particular search result type. Search result types describe the return structure for a search.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchResultTypeInfoinformation on the search result type
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindSearchCriteriaTypes
DescriptionRetrieves the list of search criteria types known by this service.
ParametersNoneNoneNo parameters
ReturnsearchCriteriaTypeInfoListlist of search criteria type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSearchCriteriaType
DescriptionRetrieves information about a particular search criteria type.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria type
ReturnsearchCriteriaTypeInfoinformation on the search criteria type
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindAuthenticationTypes
DescriptionRetrieve the list of authentication types known by this service
ParametersNoneNoneNo parameters
ReturnauthenticationTypeListlist of authentication types
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Read

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalIdsByPerson
DescriptionRetrieves a list of Principals for a given Person
ParameterspersonIdpersonIdperson identifier
ReturnprincipalIdListlist of principal ids for the specified person
ErrorsDISABLED_IDENTIFIERpersonId found but has been retired
DOES_NOT_EXISTpersonId not found
INVALID_PARAMETERinvalid personId
MISSING_PARAMETERmissing personId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalIdsBySystem
DescriptionRetrieves a list of Principals for a given System
ParameterssystemIdsystemIdsystem identifier
ReturnprincipalIdListlist of principal ids for the given system
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid systemId
MISSING_PARAMETERmissing systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchPersonIdByPrincipal
DescriptionRetrieves a Person for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnpersonIdperson identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchSystemByPrincipal
DescriptionRetrieves a System for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnsystemIdsystem identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfetchPrincipalTypeForPrincipal
DescriptionRetrieves a Principal Type for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnprincipalTypeprincipal type that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodfindPrincipalTypesByPrincipalIdList
DescriptionRetrieves a list of Principal Types for a given list of Principal Ids
ParametersprincipalIdListprincipalIdListlist of principal identifiers
ReturnprincipalTypeListList of principal types that match the supplied criteria
ErrorsDISABLED_IDENTIFIEROne or more principalIds found but have been retired
DOES_NOT_EXISTOne or more principalIds not found
INVALID_PARAMETERinvalid principalIdList
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Search

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodsearchForResults
DescriptionRetrieves results in tabular form for the specified parameters.
ParameterssearchTypeKeysearchTypeKeysearch identifier
queryParamValueListqueryParamValueslist of values for search parameters
ReturnresultListlist of results from the query
ErrorsDOES_NOT_EXISTspecified search type not found
INVALID_PARAMETERinvalid searchTypeKey, queryParamValueList
MISSING_PARAMETERsearchTypeKey, queryParamValueList not specified
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Maintenance

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodassignPrincipalToPerson
DescriptionAssigns a Principal to a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodassignPrincipalToSystem
DescriptionAssigns a Principal to a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodremovePrincipalFromPerson
DescriptionRemove a Principal from a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId, association does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodremovePrincipalFromSystem
DescriptionRemove a Principal from a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId, association does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback
+ +

Back to Operations

+ +

+ +

Capabilities

+
+ + + + + + + + + + + + + +
+
+

Labels

+ + Edit + +
+ +
+
+
+ + kss-svcs kss-svcs + Delete +
+
+ kss-pi kss-pi + Delete + +
+
+ kss-service kss-service + Delete +
+
+ kss-svb1 kss-svb1 + + Delete +
+
+ + +
+
+ + +
Enter labels to add to this page:
+ + + + +
+ Please wait  + + +
+
+
+
+ Looking for a label? Just start typing. +
+
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ Add Comment +

+
+ + + +
+
+ + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/contracts/servicetemplate.trimmed.xml b/sandbox/kss/wiki_to_java/contracts/servicetemplate.trimmed.xml new file mode 100644 index 000000000..a18d4c454 --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/servicetemplate.trimmed.xml @@ -0,0 +1 @@ +

MethodfindObjectTypes
DescriptionRetrieves the list of object type identifiers known by this service. Example: cluInfo.
ParametersNoneNoneNo parameters
ReturnobjectTypeKeyListlist of object type identifiers
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchObjectStructure
DescriptionRetrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc.
ParametersobjectTypeKeyobjectTypeKeyidentifier of the object type
ReturnobjectStructuredescribes the fields for the input object type
ErrorsDOES_NOT_EXISTspecified objectTypeKey not found
INVALID_PARAMETERinvalid objectTypeKey
MISSING_PARAMETERmissing objectTypeKey
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchEnumeration
DescriptionRetrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.
ParametersenumerationKeyenumerationKeyidentifier of the enumeration
enumContextKeycontextTypeidentifier of the enumeration context type
stringcontextValuevalue of the enumeration context
dateTimecontextDatedate and time to get the enumeration for
ReturnenumeratedValueListlist of enumerated codes and values
ErrorsDOES_NOT_EXISTenumerationKey not found
INVALID_PARAMETERinvalid enumerationKey, contextType, contextValue, contextDate
MISSING_PARAMETERmissing enumerationKey, contextType, contextValue, contextDate
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindSearchTypes
DescriptionRetrieves the list of search types known by this service.
ParametersNoneNoneNo Parameters
ReturnsearchTypeInfoListlist of search type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchSearchType
DescriptionRetrieves information about a particular search type.
ParameterssearchTypeKeysearchTypeKeyidentifier of the search type
ReturnsearchTypeInfoinformation on the search type
ErrorsDOES_NOT_EXISTspecified searchTypeKey not found
INVALID_PARAMETERinvalid searchTypeKey
MISSING_PARAMETERsearchTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindSearchTypesByResult
DescriptionRetrieves the list of search types which return results in the specified format.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindSearchTypesByCriteria
DescriptionRetrieves the list of search types which use criteria in the specified format.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria
ReturnsearchTypeInfoListlist of search type information
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindSearchResultTypes
DescriptionRetrieves the list of search result types known by this service. Search result types describe the return structure for a search.
ParametersNoneNoneNo Parameters
ReturnsearchResultTypeInfoListlist of search result type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchSearchResultType
DescriptionRetrieves information about a particular search result type. Search result types describe the return structure for a search.
ParameterssearchResultTypeKeysearchResultTypeKeyidentifier of the search result type
ReturnsearchResultTypeInfoinformation on the search result type
ErrorsDOES_NOT_EXISTspecified searchResultTypeKey not found
INVALID_PARAMETERinvalid searchResultTypeKey
MISSING_PARAMETERsearchResultTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindSearchCriteriaTypes
DescriptionRetrieves the list of search criteria types known by this service.
ParametersNoneNoneNo parameters
ReturnsearchCriteriaTypeInfoListlist of search criteria type information
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchSearchCriteriaType
DescriptionRetrieves information about a particular search criteria type.
ParameterssearchCriteriaTypeKeysearchCriteriaTypeKeyidentifier of the search criteria type
ReturnsearchCriteriaTypeInfoinformation on the search criteria type
ErrorsDOES_NOT_EXISTspecified searchCriteriaTypeKey not found
INVALID_PARAMETERinvalid searchCriteriaTypeKey
MISSING_PARAMETERsearchCriteriaTypeKey not specified
OPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindAuthenticationTypes
DescriptionRetrieve the list of authentication types known by this service
ParametersNoneNoneNo parameters
ReturnauthenticationTypeListlist of authentication types
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback

Back to Operations

Read

MethodfindPrincipalIdsByPerson
DescriptionRetrieves a list of Principals for a given Person
ParameterspersonIdpersonIdperson identifier
ReturnprincipalIdListlist of principal ids for the specified person
ErrorsDISABLED_IDENTIFIERpersonId found but has been retired
DOES_NOT_EXISTpersonId not found
INVALID_PARAMETERinvalid personId
MISSING_PARAMETERmissing personId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindPrincipalIdsBySystem
DescriptionRetrieves a list of Principals for a given System
ParameterssystemIdsystemIdsystem identifier
ReturnprincipalIdListlist of principal ids for the given system
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid systemId
MISSING_PARAMETERmissing systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchPersonIdByPrincipal
DescriptionRetrieves a Person for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnpersonIdperson identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchSystemByPrincipal
DescriptionRetrieves a System for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnsystemIdsystem identifier that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERsystemId found but has been retired
DOES_NOT_EXISTsystemId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfetchPrincipalTypeForPrincipal
DescriptionRetrieves a Principal Type for a given Principal
ParametersprincipalIdprincipalIdprincipal identifier
ReturnprincipalTypeprincipal type that matches the supplied criteria
ErrorsDISABLED_IDENTIFIERprincipalId found but has been retired
DOES_NOT_EXISTprincipalId not found
INVALID_PARAMETERinvalid principalId
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodfindPrincipalTypesByPrincipalIdList
DescriptionRetrieves a list of Principal Types for a given list of Principal Ids
ParametersprincipalIdListprincipalIdListlist of principal identifiers
ReturnprincipalTypeListList of principal types that match the supplied criteria
ErrorsDISABLED_IDENTIFIEROne or more principalIds found but have been retired
DOES_NOT_EXISTOne or more principalIds not found
INVALID_PARAMETERinvalid principalIdList
MISSING_PARAMETERmissing principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

Search

MethodsearchForResults
DescriptionRetrieves results in tabular form for the specified parameters.
ParameterssearchTypeKeysearchTypeKeysearch identifier
queryParamValueListqueryParamValueslist of values for search parameters
ReturnresultListlist of results from the query
ErrorsDOES_NOT_EXISTspecified search type not found
INVALID_PARAMETERinvalid searchTypeKey, queryParamValueList
MISSING_PARAMETERsearchTypeKey, queryParamValueList not specified
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

Maintenance

MethodassignPrincipalToPerson
DescriptionAssigns a Principal to a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodassignPrincipalToSystem
DescriptionAssigns a Principal to a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsALREADY_EXISTSassociation already exists
DISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodremovePrincipalFromPerson
DescriptionRemove a Principal from a Person
ParametersprincipalIdprincipalIdprincipal identifier
personIdpersonIdperson identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERpersonId or principalId found but has been retired
DOES_NOT_EXISTpersonId, principalId, association does not exist
INVALID_PARAMETERinvalid personId, principalId
MISSING_PARAMETERmissing personId, principalId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

MethodremovePrincipalFromSystem
DescriptionRemove a Principal from a System
ParametersprincipalIdprincipalIdprincipal identifier
systemIdsystemIdsystem identifier
Returnstatusstatus of the operation
ErrorsDISABLED_IDENTIFIERprincipalId, systemId found but has been retired
DOES_NOT_EXISTprincipalId, systemId, association does not exist
INVALID_PARAMETERinvalid principalId, systemId
MISSING_PARAMETERmissing principalId, systemId
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
Capabilities
Use Cases
Comments/Feedback

Back to Operations

\ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/contracts/~contract b/sandbox/kss/wiki_to_java/contracts/~contract new file mode 100644 index 000000000..e23ba25bc --- /dev/null +++ b/sandbox/kss/wiki_to_java/contracts/~contract @@ -0,0 +1,853 @@ + + + + Comment Service - KS Workspace - Confluence + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + +

+ + + Comment Service + +

+ + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ +

Comment Service

+ + + + + + + + + + + + +
NameCommentService
VersionDevRelease Notes
+ + + + + + + +
References Operations Capabilities
+ +

Description

+

The Comment Service manages user comments associated with any object.This service is to allow comments and tags to be created for objects across the system. There is no expectation that the Objects no about these at all, and therefore objects can be deleted while there were still tags or comments.

+ +

We're using "objects" in a different way than elsewhere, so we need a better name.
+ How much threading do we need

+ +

Operations

+ + +
Setup
+

Dictionary Operations
+findObjectTypes
+fetchObjectStructure
+fetchEnumeration

+ +

Search Operations
+ +findSearchTypes
+fetchSearchType
+findSearchTypesByResult
+findSearchTypesByCriteria
+findSearchResultTypes
+fetchSearchResultType
+findSearchCriteriaTypes
+fetchSearchCriteriaType

+ +

Domain Operations
+getReferenceTypes
+getCommentTypes – Do we need these? Separate Personal from Official etc
+getTagTypes – Do we need these?

+
+ +
Read
+

getTagsForReference
+ +getCommentsForReference

+ +

getComments

+ +

getReferencesByTag
+getReferencesOfTypeByTag

+ +

getTags

+
+ +
Search
+ +
Maintenance
+

addTag
+removeTag

+ +

addComment

+ +

removeComment

+ +

removeAllTags
+removeAllComments

+
+ +

+ +

Setup

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodgetReferenceTypes
DescriptionRetrieves the list of types which can be tagged or commented.
ParametersNoneNoneNo parameters
ReturnreferenceTypeInfoListthe list of types which can be tagged or commented
ErrorsOPERATION_FAILEDunable to complete request
Capabilities
Use Cases
Comments/Feedback
+

Back to Operations

+ +

Read

+ +

Search

+ +

Maintenance

+
+ + + + + + + + + + + + + +
+
+

Labels

+ Edit + + +
+ +
+
+
+ kss-svcs kss-svcs + Delete + +
+
+ kss-service kss-service + Delete +
+
+ + +
+ +
+ + +
Enter labels to add to this page:
+ + + + + +
+ Please wait  + +
+
+
+
+ Looking for a label? Just start typing. +
+ +
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + +
+ + + + +

+ Add Comment +

+
+ + + + +
+
+ + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/pom.xml b/sandbox/kss/wiki_to_java/pom.xml new file mode 100644 index 000000000..099e339a2 --- /dev/null +++ b/sandbox/kss/wiki_to_java/pom.xml @@ -0,0 +1,26 @@ + + + 4.0.0 + org.kuali.student.mojo + maven-kscontract-plugin + 0.0.1-SNAPSHOT + maven-plugin + + + + + + org.apache.maven + maven-plugin-api + 2.0 + + + net.sf.saxon + saxon + 8.7 + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/src/main/java/CSpace.java b/sandbox/kss/wiki_to_java/src/main/java/CSpace.java new file mode 100644 index 000000000..6dd64f263 --- /dev/null +++ b/sandbox/kss/wiki_to_java/src/main/java/CSpace.java @@ -0,0 +1,78 @@ +/** + * + */ + +import java.io.File; +import java.net.MalformedURLException; +import java.net.URL; + +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; + +import org.kuali.student.mojo.*; + +/** + * @author remillet + * + */ +public class CSpace { + + /** + * @param args + */ + public static void main(String[] args) { + + // the contract file to transform + File contractFile = null; +// contractFile = new File("C:/dev/src/kss/maven-kscontract-plugin/maven-kscontract-plugin/contracts/ffservice"); + + // the URL to the contract to transform + URL contractURL = null; + try { +// contractURL = new URL("https://test.kuali.org/confluence/display/KULSTU/Authentication+Service"); + contractURL = new URL("http://wiki.collectionspace.org/display/collectionspace/wikitojavatestservice"); + + // + } catch (MalformedURLException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + + // where to store the transformed output + File outputDirectory = + new File("C:/dev/src/kss/maven-kscontract-plugin/maven-kscontract-plugin/transforms"); + + // XSLT file describing the transform + File transformFile = + new File("C:/dev/src/kss/maven-kscontract-plugin/maven-kscontract-plugin/src/main/resources/interface.xml"); + + // XSLT file describing the message transform + File messageTransformFile = + new File("C:/dev/src/kss/maven-kscontract-plugin/maven-kscontract-plugin/src/main/resources/messageInterface.xml"); + + // the session ID token + String jsessionId = "53F14F3833498C0A43DA87B273D1DDB7.Kuali3_1Engine"; + + + + KsContractMojo kssContractMojo = new KsContractMojo( + contractFile, + contractURL, + outputDirectory, + transformFile, + messageTransformFile, + jsessionId); + + try { + kssContractMojo.execute(); + } + catch (MojoExecutionException mee) { + System.err.print(mee.toString()); + } + catch (MojoFailureException mfe) { + System.err.print(mfe.toString()); + } + + } + +} diff --git a/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/contract/ContractReader.java b/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/contract/ContractReader.java new file mode 100644 index 000000000..c64fecc91 --- /dev/null +++ b/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/contract/ContractReader.java @@ -0,0 +1,96 @@ +package org.kuali.student.contract; + +import java.io.BufferedReader; +import java.io.ByteArrayInputStream; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.StringReader; +import java.io.UnsupportedEncodingException; +import java.net.URL; +import java.net.URLConnection; + +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.transform.stream.StreamSource; + +import org.w3c.dom.Document; +import org.xml.sax.SAXException; +import java.util.regex.Pattern; + +public class ContractReader { + + private String contractText; + + public ContractReader(File file) throws FileNotFoundException, IOException { + FileReader fileReader = new FileReader(file); + BufferedReader reader = new BufferedReader(fileReader); + + contractText = trimContract(reader); + } + + public ContractReader(URL url, String jsessionId) throws IOException { + URLConnection connection = url.openConnection(); + connection.setRequestProperty("Cookie", "JSESSIONID=" + jsessionId); + + InputStreamReader myReader = new InputStreamReader(connection.getInputStream()); + BufferedReader reader = new BufferedReader(myReader); + + contractText = trimContract(reader); + } + + public Document getDocument() throws ParserConfigurationException, UnsupportedEncodingException, IOException, SAXException { + DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); + DocumentBuilder builder = factory.newDocumentBuilder(); + + return builder.parse(new ByteArrayInputStream(contractText.getBytes("UTF-8"))); + } + + public StreamSource getStreamSource() { + StringReader stringReader = new StringReader(contractText); + + return new StreamSource(stringReader); + } + + protected String trimContract(BufferedReader reader) throws IOException { + + String result = null; + StringBuilder builder = new StringBuilder(); + String line; + boolean inContract = false; + + while ((line = reader.readLine()) != null) { +// System.out.println(line); + if (!inContract) { + if (line.contains("Setup")) { + inContract = true; + builder.append(""); + } + } else { +// if (line.contains("Capabilities")) { + if (Pattern.matches(".*\\s*Capabilities\\s*.*", line) == true) { + inContract = false; + } else { + builder.append(line); + } + } + } + + builder.append("" + "\n"); + result = builder.toString(); + + System.out.print(result); + + return result; + } + + /** + * @return the contractText + */ + public String getContractText() { + return contractText; + } +} diff --git a/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/contract/MessageContractReader.java b/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/contract/MessageContractReader.java new file mode 100644 index 000000000..4565f226e --- /dev/null +++ b/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/contract/MessageContractReader.java @@ -0,0 +1,69 @@ +package org.kuali.student.contract; + +import java.io.BufferedReader; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.net.URL; + +public class MessageContractReader extends ContractReader { + + /** + * @param url + * @throws IOException + */ + public MessageContractReader(URL url, String jsessionId) throws IOException { + super(url, jsessionId); + // TODO Auto-generated constructor stub + } + + public MessageContractReader(File file) throws FileNotFoundException, + IOException { + super(file); + // TODO Auto-generated constructor stub + } + + /* + * (non-Javadoc) + * + * @see org.kuali.student.contract.ContractReader#trimContract(java.io.BufferedReader) + */ + @Override + protected String trimContract(BufferedReader reader) throws IOException { + StringBuilder builder = new StringBuilder(); + String line; + + // Add in xml header and entity definitions + builder.append("" + "" + "]>"); + + // Get rid of the first line (doctype info stuff) + reader.readLine(); + + // read each line and fix any open tags, bad attributes, and '&' symbols + // without a ';' + while ((line = reader.readLine()) != null) { + + // Check if the current line has a tag that does not end yet + if (line.matches(".*<[^>]+")) { + + // Concatenate the next lines until the tag is closed + String newLine; + while ((newLine = reader.readLine()) != null + && !(line += newLine).contains(">")) { + } + } + + // Do some regex to clean up the tags + line = line.replaceAll("border=0", "border=\"0\""); + line = line.replaceAll("([^:])nowrap([^=])", "$1nowrap=\"true\"$2"); + line = line.replaceAll("&(\\w+[^;])", "$1"); + line = line.replaceAll("(<(META|meta|br|hr|col|link|img|input)(\\s+[\\w-]+\\s*=\\s*(\"([^\"]*)\"|'([^']*)'))*\\s*)>", "$1/>"); + line = line.replaceAll("
", "
"); + builder.append(line + "\n"); + } + + return builder.toString(); + } + +} diff --git a/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/mojo/KsContractMojo.java b/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/mojo/KsContractMojo.java new file mode 100644 index 000000000..afbde3120 --- /dev/null +++ b/sandbox/kss/wiki_to_java/src/main/java/org/kuali/student/mojo/KsContractMojo.java @@ -0,0 +1,322 @@ +package org.kuali.student.mojo; + +import java.io.File; +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.HashSet; +import java.util.Set; + +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.transform.Result; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerConfigurationException; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactoryConfigurationError; +import javax.xml.transform.stream.StreamResult; +import javax.xml.transform.stream.StreamSource; + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.kuali.student.contract.ContractReader; +import org.kuali.student.contract.MessageContractReader; +import org.w3c.dom.DOMException; +import org.w3c.dom.Document; +import org.w3c.dom.NamedNodeMap; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; +import org.xml.sax.SAXException; + +/** + * Creates WS service interface from wiki service contract. + * + * @goal contractToJava + */ +public class KsContractMojo extends AbstractMojo { + + public KsContractMojo( + File contractFile, + URL contractURL, + File outputDirectory, + File transformFile, + File messageTransformFile, + String jsessionId) + { + this.contractFile = contractFile; + this.contractURL = contractURL; + this.outputDirectory = outputDirectory; + this.transformFile = transformFile; + this.messageTransformFile = messageTransformFile; + this.jsessionId = jsessionId; + + return; + } + + public KsContractMojo() { + this.contractFile = null; + this.contractURL = null; + } + + /** + * Path to service contract file. + * + * @parameter + */ + private File contractFile; + + /** + * URL of service contract from wiki. + * + * @parameter + */ + private URL contractURL; + + /** + * Path to output directory. + * + * @parameter + */ + private File outputDirectory; + + /** + * Path to custom xslt. + * + * @parameter + */ + private File transformFile; + + /** + * Path to custom xslt. + * + * @parameter + */ + private File messageTransformFile; + + /** + * JSESSIONID from a current session + * + * @parameter + */ + private String jsessionId; + + public void execute() throws MojoExecutionException, MojoFailureException { + + ContractReader contract; + + try { + if (contractURL != null) { + contract = new ContractReader(contractURL, jsessionId); + } else { + contract = new ContractReader(contractFile); + } + } catch (Exception ex) { + throw new MojoExecutionException("Can't parse contract", ex); + } + + StreamSource wsdlXslt; + if (transformFile == null) { + wsdlXslt = new StreamSource(this.getClass().getClassLoader() + .getResourceAsStream("interface.xml")); + } else { + wsdlXslt = new StreamSource(transformFile); + } + + try { + Transformer transformer = net.sf.saxon.TransformerFactoryImpl + .newInstance().newTransformer(wsdlXslt); + + Result result = new StreamResult(new File(outputDirectory, + "foo.java")); + transformer.transform(contract.getStreamSource(), result); + + findParams(contract.getDocument()); + } catch (TransformerConfigurationException tcex) { + getLog().error(tcex); + throw new MojoExecutionException("Can't initialize xslt.", tcex); + } catch (TransformerException tex) { + getLog().error(tex); + throw new MojoExecutionException("Can't transform contract.", tex); + } catch (Exception ex) { + ex.printStackTrace(); + throw new MojoExecutionException("Error parsing params", ex); + } + } + + public void findParamsFromMessage(String param, URL url, + Set alreadyParsedUrlSet) { + if (alreadyParsedUrlSet.contains(url) || "datetime".equals(param.toLowerCase()) + || "string".equals(param.toLowerCase()) || "boolean".equals(param.toLowerCase()) + || "integer".equals(param.toLowerCase())) { + return; + } + ContractReader contract; + try { + contract = new MessageContractReader(url, jsessionId); + // Create the java code + if (!param.endsWith("List") && !param.endsWith("Id") + && !param.endsWith("Key") && !param.endsWith("Type")) { + message2Java(contract, param); + } + // add this url to the already oarsed list + alreadyParsedUrlSet.add(url); + + // recurse through the node to + NodeList nodeList = contract.getDocument().getElementsByTagName( + "td"); + for (int i = 0, iCnt = nodeList.getLength(); i < iCnt; i++) { + Node node = nodeList.item(i); + NamedNodeMap nodeMap = node.getAttributes(); + if (nodeMap != null + && nodeMap.getNamedItem("class") != null + && "structType".equals(nodeMap.getNamedItem("class") + .getNodeValue())) { + Node anchor = node.getFirstChild(); + String urlString = anchor.getAttributes().getNamedItem( + "href").getNodeValue(); + if (!urlString.startsWith("http") + && !urlString.startsWith("file")) { + urlString = contractURL.getProtocol()+"://"+contractURL.getHost() + + urlString; + } + URL newUrl = new URL(urlString); + String newParam = anchor.getTextContent().trim(); + if (!newParam.startsWith("<") + && !alreadyParsedUrlSet.contains(newUrl)) { + findParamsFromMessage(newParam, newUrl, + alreadyParsedUrlSet); + } + } + } + } catch (IOException e) { + getLog().warn( + "Error loading page for Type '" + param + "'" + + e.getMessage()); + } catch (ParserConfigurationException e) { + getLog().warn( + "Error parsing page for Type '" + param + "'" + + e.getMessage()); + } catch (SAXException e) { + getLog().warn( + "Error parsing page for Type '" + param + "'" + + e.getMessage()); + } + } + + public void findParams(Document document) { + Set alreadyParsedUrlSet = new HashSet(); + NodeList nodeList = document.getElementsByTagName("td"); + for (int i = 0, iCnt = nodeList.getLength(); i < iCnt; i++) { + Node node = nodeList.item(i); + NamedNodeMap nodeMap = node.getAttributes(); + if (nodeMap != null + && ("methodParamType".equals(nodeMap.getNamedItem("class") + .getNodeValue()) || "methodReturnType" + .equals(nodeMap.getNamedItem("class") + .getNodeValue()))) { + String param = node.getFirstChild().getTextContent().trim(); + if (!"None".equals(param) && !param.startsWith("<") + && !param.endsWith("Id") && !param.endsWith("Key")) { + try { + String urlString = node.getFirstChild().getAttributes() + .getNamedItem("href").getNodeValue(); + System.out.println("urlString:" + urlString); + System.out.println("contractURL:" + contractURL); + if (!urlString.startsWith("http") + && !urlString.startsWith("file")) { + urlString = contractURL.getProtocol()+"://"+contractURL.getHost() + + urlString; + } + findParamsFromMessage(param, new URL(urlString), + alreadyParsedUrlSet); + } catch (MalformedURLException e) { + getLog().warn( + "Error loading page for Type '" + param + "'" + + e.getMessage()); + } catch (DOMException e) { + getLog().warn( + "DOM Error parsing page for Type '" + param + + "'" + e.getMessage()); + } + } + } + } + } + + private void message2Java(ContractReader contract, String param) { + StreamSource wsdlXslt; + if (messageTransformFile == null) { + wsdlXslt = new StreamSource(this.getClass().getClassLoader() + .getResourceAsStream("messageInterface.xml")); + } else { + wsdlXslt = new StreamSource(messageTransformFile); + } + try { + Transformer transformer = net.sf.saxon.TransformerFactoryImpl + .newInstance().newTransformer(wsdlXslt); + + Result result = new StreamResult(new File(outputDirectory, param + .substring(0, 1).toUpperCase() + + param.substring(1) + ".java")); + transformer.transform(contract.getStreamSource(), result); + } catch (TransformerConfigurationException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } catch (TransformerFactoryConfigurationError e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } catch (TransformerException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + + } + + public File getContractFile() { + return contractFile; + } + + public void setContractFile(File contractFile) { + this.contractFile = contractFile; + } + + public URL getContractURL() { + return contractURL; + } + + public void setContractURL(URL contractURL) { + this.contractURL = contractURL; + } + + public File getOutputDirectory() { + return outputDirectory; + } + + public void setOutputDirectory(File outputDirectory) { + this.outputDirectory = outputDirectory; + } + + public File getTransformFile() { + return transformFile; + } + + public void setTransformFile(File transformFile) { + this.transformFile = transformFile; + } + + /** + * @return the messageTransformFile + */ + public File getMessageTransformFile() { + return messageTransformFile; + } + + /** + * @param messageTransformFile + * the messageTransformFile to set + */ + public void setMessageTransformFile(File messageTransformFile) { + this.messageTransformFile = messageTransformFile; + } + +} diff --git a/sandbox/kss/wiki_to_java/src/main/resources/interface.xml b/sandbox/kss/wiki_to_java/src/main/resources/interface.xml new file mode 100644 index 000000000..180860e6e --- /dev/null +++ b/sandbox/kss/wiki_to_java/src/main/resources/interface.xml @@ -0,0 +1,143 @@ + + + + + +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + + + public interface foo { + + /** + * + + + + + * @param + + + + + + + * @return + + + + * @throws + + Exception + + + + */ + public + + + + + + + + ( + + ) + + ; + + } + + + + + , + + @WebParam(name=" + + ") + + + + + + + + + + + + + , + + + throws + + + Exception + + + + + + + List< + + + + + + > + + + Date + + + String + + + String + + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/src/main/resources/messageInterface.xml b/sandbox/kss/wiki_to_java/src/main/resources/messageInterface.xml new file mode 100644 index 000000000..43da376ea --- /dev/null +++ b/sandbox/kss/wiki_to_java/src/main/resources/messageInterface.xml @@ -0,0 +1,154 @@ + + + + + + + + + +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class + + implements Serializable { + private static final long serialVersionUID = 1L; + + + + @XmlAttribute + + + @XmlElement + + + private + + + + ; + + + + + + public + + get + + () { + + + if ( + + == null) { + + + = new Array + + (); + } + + return + + + ; + } + + + public void set + + ( + + + + ) { + this. + + = + + ; + } + + + } + + + + + List< + + > + + + Date + + + String + + + String + + + String + + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/target/classes/CSpace.class b/sandbox/kss/wiki_to_java/target/classes/CSpace.class new file mode 100644 index 000000000..fb0e8a3fa Binary files /dev/null and b/sandbox/kss/wiki_to_java/target/classes/CSpace.class differ diff --git a/sandbox/kss/wiki_to_java/target/classes/META-INF/maven/plugin.xml b/sandbox/kss/wiki_to_java/target/classes/META-INF/maven/plugin.xml new file mode 100644 index 000000000..1e578ce2f --- /dev/null +++ b/sandbox/kss/wiki_to_java/target/classes/META-INF/maven/plugin.xml @@ -0,0 +1,70 @@ + + + org.kuali.student.mojo + maven-kscontract-plugin + 0.0.1-SNAPSHOT + kscontract + false + true + + + contractToJava + Creates WS service interface from wiki service contract. + false + true + false + false + false + true + org.kuali.student.mojo.KsContractMojo + java + per-lookup + once-per-session + + + contractFile + java.io.File + false + true + Path to service contract file. + + + contractURL + java.net.URL + false + true + URL of service contract from wiki. + + + jsessionId + java.lang.String + false + true + JSESSIONID from a current session + + + messageTransformFile + java.io.File + false + true + Path to custom xslt. + + + outputDirectory + java.io.File + false + true + Path to output directory. + + + transformFile + java.io.File + false + true + Path to custom xslt. + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/target/classes/interface.xml b/sandbox/kss/wiki_to_java/target/classes/interface.xml new file mode 100644 index 000000000..180860e6e --- /dev/null +++ b/sandbox/kss/wiki_to_java/target/classes/interface.xml @@ -0,0 +1,143 @@ + + + + + +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + + + public interface foo { + + /** + * + + + + + * @param + + + + + + + * @return + + + + * @throws + + Exception + + + + */ + public + + + + + + + + ( + + ) + + ; + + } + + + + + , + + @WebParam(name=" + + ") + + + + + + + + + + + + + , + + + throws + + + Exception + + + + + + + List< + + + + + + > + + + Date + + + String + + + String + + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/target/classes/messageInterface.xml b/sandbox/kss/wiki_to_java/target/classes/messageInterface.xml new file mode 100644 index 000000000..43da376ea --- /dev/null +++ b/sandbox/kss/wiki_to_java/target/classes/messageInterface.xml @@ -0,0 +1,154 @@ + + + + + + + + + +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class + + implements Serializable { + private static final long serialVersionUID = 1L; + + + + @XmlAttribute + + + @XmlElement + + + private + + + + ; + + + + + + public + + get + + () { + + + if ( + + == null) { + + + = new Array + + (); + } + + return + + + ; + } + + + public void set + + ( + + + + ) { + this. + + = + + ; + } + + + } + + + + + List< + + > + + + Date + + + String + + + String + + + String + + + + + + + \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/contract/ContractReader.class b/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/contract/ContractReader.class new file mode 100644 index 000000000..63daac9d9 Binary files /dev/null and b/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/contract/ContractReader.class differ diff --git a/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/contract/MessageContractReader.class b/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/contract/MessageContractReader.class new file mode 100644 index 000000000..8ef21debb Binary files /dev/null and b/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/contract/MessageContractReader.class differ diff --git a/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/mojo/KsContractMojo.class b/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/mojo/KsContractMojo.class new file mode 100644 index 000000000..4f2f43982 Binary files /dev/null and b/sandbox/kss/wiki_to_java/target/classes/org/kuali/student/mojo/KsContractMojo.class differ diff --git a/sandbox/kss/wiki_to_java/transforms/Attribute.java b/sandbox/kss/wiki_to_java/transforms/Attribute.java new file mode 100644 index 000000000..f8b5ab6b0 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/Attribute.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class Attribute implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String value; + + @XmlAttribute + private String key; + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/CommMediaTypeInfo.java b/sandbox/kss/wiki_to_java/transforms/CommMediaTypeInfo.java new file mode 100644 index 000000000..7906e05cb --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/CommMediaTypeInfo.java @@ -0,0 +1,100 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class CommMediaTypeInfo Structure implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String name; + + @XmlElement + private String desc; + + @XmlElement + private Date effectiveDate; + + @XmlElement + private Date expirationDate; + + @XmlElement + private List attributes; + + @XmlAttribute + private String key; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public Date getEffectiveDate() { + return effectiveDate; + } + + public void setEffectiveDate(Date effectiveDate) { + this.effectiveDate = effectiveDate; + } + + public Date getExpirationDate() { + return expirationDate; + } + + public void setExpirationDate(Date expirationDate) { + this.expirationDate = expirationDate; + } + + public List getAttributes() { + if (attributes == null) { + attributes = new ArrayList(); + } + return attributes; + } + + public void setAttributes(List attributes) { + this.attributes = attributes; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/CommUsageTypeInfo.java b/sandbox/kss/wiki_to_java/transforms/CommUsageTypeInfo.java new file mode 100644 index 000000000..6f6b2e5ba --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/CommUsageTypeInfo.java @@ -0,0 +1,100 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class CommUsageTypeInfo implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String name; + + @XmlElement + private String desc; + + @XmlElement + private Date effectiveDate; + + @XmlElement + private Date expirationDate; + + @XmlElement + private List attributes; + + @XmlAttribute + private String key; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public Date getEffectiveDate() { + return effectiveDate; + } + + public void setEffectiveDate(Date effectiveDate) { + this.effectiveDate = effectiveDate; + } + + public Date getExpirationDate() { + return expirationDate; + } + + public void setExpirationDate(Date expirationDate) { + this.expirationDate = expirationDate; + } + + public List getAttributes() { + if (attributes == null) { + attributes = new ArrayList(); + } + return attributes; + } + + public void setAttributes(List attributes) { + this.attributes = attributes; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/Date.java b/sandbox/kss/wiki_to_java/transforms/Date.java new file mode 100644 index 000000000..75b7ffdaf --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/Date.java @@ -0,0 +1,31 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class Date implements Serializable { + + private static final long serialVersionUID = 1L; +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/EnumContextInfo.java b/sandbox/kss/wiki_to_java/transforms/EnumContextInfo.java new file mode 100644 index 000000000..958061624 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/EnumContextInfo.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class EnumContextInfo implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private FieldDescriptor contextValueDescriptor; + + @XmlAttribute + private String type; + + public FieldDescriptor getContextValueDescriptor() { + return contextValueDescriptor; + } + + public void setContextValueDescriptor(FieldDescriptor contextValueDescriptor) { + this.contextValueDescriptor = contextValueDescriptor; + } + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/EnumContextValue.java b/sandbox/kss/wiki_to_java/transforms/EnumContextValue.java new file mode 100644 index 000000000..629ad5dd2 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/EnumContextValue.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class EnumContextValue implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String type; + + @XmlElement + private String value; + + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/EnumFieldView.java b/sandbox/kss/wiki_to_java/transforms/EnumFieldView.java new file mode 100644 index 000000000..2179423da --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/EnumFieldView.java @@ -0,0 +1,56 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class EnumFieldView implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private List contextDescriptors; + + @XmlAttribute + private String key; + + public List getContextDescriptors() { + if (contextDescriptors == null) { + contextDescriptors = new ArrayList(); + } + return contextDescriptors; + } + + public void setContextDescriptors(List contextDescriptors) { + this.contextDescriptors = contextDescriptors; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/EnumeratedValue.java b/sandbox/kss/wiki_to_java/transforms/EnumeratedValue.java new file mode 100644 index 000000000..123844caa --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/EnumeratedValue.java @@ -0,0 +1,111 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class EnumeratedValue implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String code; + + @XmlElement + private String abbrevValue; + + @XmlElement + private String value; + + @XmlElement + private Date effectiveDate; + + @XmlElement + private Date expirationDate; + + @XmlElement + private String sortKey; + + @XmlElement + private List contexts; + + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public String getAbbrevValue() { + return abbrevValue; + } + + public void setAbbrevValue(String abbrevValue) { + this.abbrevValue = abbrevValue; + } + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public Date getEffectiveDate() { + return effectiveDate; + } + + public void setEffectiveDate(Date effectiveDate) { + this.effectiveDate = effectiveDate; + } + + public Date getExpirationDate() { + return expirationDate; + } + + public void setExpirationDate(Date expirationDate) { + this.expirationDate = expirationDate; + } + + public String getSortKey() { + return sortKey; + } + + public void setSortKey(String sortKey) { + this.sortKey = sortKey; + } + + public List getContexts() { + if (contexts == null) { + contexts = new ArrayList(); + } + return contexts; + } + + public void setContexts(List contexts) { + this.contexts = contexts; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/FieldDescriptor.java b/sandbox/kss/wiki_to_java/transforms/FieldDescriptor.java new file mode 100644 index 000000000..cbab3c16d --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/FieldDescriptor.java @@ -0,0 +1,174 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class FieldDescriptor implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String name; + + @XmlElement + private String desc; + + @XmlElement + private String dataType; + + @XmlElement + private Integer minLength; + + @XmlElement + private String maxLength; + + @XmlElement + private String validChars; + + @XmlElement + private String invalidChars; + + @XmlElement + private String minValue; + + @XmlElement + private String maxValue; + + @XmlElement + private EnumFieldView enumFieldView; + + @XmlElement + private Integer minOccurs; + + @XmlElement + private String maxOccurs; + + @XmlElement + private Boolean readOnly; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public String getDataType() { + return dataType; + } + + public void setDataType(String dataType) { + this.dataType = dataType; + } + + public Integer getMinLength() { + return minLength; + } + + public void setMinLength(Integer minLength) { + this.minLength = minLength; + } + + public String getMaxLength() { + return maxLength; + } + + public void setMaxLength(String maxLength) { + this.maxLength = maxLength; + } + + public String getValidChars() { + return validChars; + } + + public void setValidChars(String validChars) { + this.validChars = validChars; + } + + public String getInvalidChars() { + return invalidChars; + } + + public void setInvalidChars(String invalidChars) { + this.invalidChars = invalidChars; + } + + public String getMinValue() { + return minValue; + } + + public void setMinValue(String minValue) { + this.minValue = minValue; + } + + public String getMaxValue() { + return maxValue; + } + + public void setMaxValue(String maxValue) { + this.maxValue = maxValue; + } + + public EnumFieldView getEnumFieldView() { + return enumFieldView; + } + + public void setEnumFieldView(EnumFieldView enumFieldView) { + this.enumFieldView = enumFieldView; + } + + public Integer getMinOccurs() { + return minOccurs; + } + + public void setMinOccurs(Integer minOccurs) { + this.minOccurs = minOccurs; + } + + public String getMaxOccurs() { + return maxOccurs; + } + + public void setMaxOccurs(String maxOccurs) { + this.maxOccurs = maxOccurs; + } + + public Boolean getReadOnly() { + return readOnly; + } + + public void setReadOnly(Boolean readOnly) { + this.readOnly = readOnly; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/FieldSelector.java b/sandbox/kss/wiki_to_java/transforms/FieldSelector.java new file mode 100644 index 000000000..55f5c225e --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/FieldSelector.java @@ -0,0 +1,64 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class FieldSelector implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private FieldDescriptor fieldDescriptor; + + @XmlElement + private Boolean isSelector; + + @XmlAttribute + private String key; + + public FieldDescriptor getFieldDescriptor() { + return fieldDescriptor; + } + + public void setFieldDescriptor(FieldDescriptor fieldDescriptor) { + this.fieldDescriptor = fieldDescriptor; + } + + public Boolean getIsSelector() { + return isSelector; + } + + public void setIsSelector(Boolean isSelector) { + this.isSelector = isSelector; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/ObjectStructure.java b/sandbox/kss/wiki_to_java/transforms/ObjectStructure.java new file mode 100644 index 000000000..4eab0b98f --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/ObjectStructure.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class ObjectStructure implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private TypeSelector type; + + @XmlAttribute + private String objectTypeKey; + + public TypeSelector getType() { + return type; + } + + public void setType(TypeSelector type) { + this.type = type; + } + + public String getObjectTypeKey() { + return objectTypeKey; + } + + public void setObjectTypeKey(String objectTypeKey) { + this.objectTypeKey = objectTypeKey; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/QueryParamInfo.java b/sandbox/kss/wiki_to_java/transforms/QueryParamInfo.java new file mode 100644 index 000000000..5a2b2a083 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/QueryParamInfo.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class QueryParamInfo implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private FieldDescriptor fieldDescriptor; + + @XmlAttribute + private String key; + + public FieldDescriptor getFieldDescriptor() { + return fieldDescriptor; + } + + public void setFieldDescriptor(FieldDescriptor fieldDescriptor) { + this.fieldDescriptor = fieldDescriptor; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/QueryParamValue.java b/sandbox/kss/wiki_to_java/transforms/QueryParamValue.java new file mode 100644 index 000000000..5235bd6cf --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/QueryParamValue.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class QueryParamValue implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String value; + + @XmlAttribute + private String key; + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/Result.java b/sandbox/kss/wiki_to_java/transforms/Result.java new file mode 100644 index 000000000..501a45934 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/Result.java @@ -0,0 +1,42 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class Result implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private ResultCell resultCell; + + public ResultCell getResultCell() { + return resultCell; + } + + public void setResultCell(ResultCell resultCell) { + this.resultCell = resultCell; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/ResultCell.java b/sandbox/kss/wiki_to_java/transforms/ResultCell.java new file mode 100644 index 000000000..ca744a51a --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/ResultCell.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class ResultCell implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String value; + + @XmlAttribute + private String key; + + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/ResultColumnInfo.java b/sandbox/kss/wiki_to_java/transforms/ResultColumnInfo.java new file mode 100644 index 000000000..e1cad0e4e --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/ResultColumnInfo.java @@ -0,0 +1,75 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class ResultColumnInfo implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String name; + + @XmlElement + private String desc; + + @XmlElement + private String dataType; + + @XmlAttribute + private String key; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public String getDataType() { + return dataType; + } + + public void setDataType(String dataType) { + this.dataType = dataType; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/SearchCriteriaTypeInfo.java b/sandbox/kss/wiki_to_java/transforms/SearchCriteriaTypeInfo.java new file mode 100644 index 000000000..493cb925a --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/SearchCriteriaTypeInfo.java @@ -0,0 +1,78 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class SearchCriteriaTypeInfo implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String name; + + @XmlElement + private String desc; + + @XmlElement + private List queryParams; + + @XmlAttribute + private String key; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public List getQueryParams() { + if (queryParams == null) { + queryParams = new ArrayList(); + } + return queryParams; + } + + public void setQueryParams(List queryParams) { + this.queryParams = queryParams; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/SearchResultTypeInfo.java b/sandbox/kss/wiki_to_java/transforms/SearchResultTypeInfo.java new file mode 100644 index 000000000..9eec714b9 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/SearchResultTypeInfo.java @@ -0,0 +1,78 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class SearchResultTypeInfo implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String name; + + @XmlElement + private String desc; + + @XmlElement + private List resultColumns; + + @XmlAttribute + private String key; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public List getResultColumns() { + if (resultColumns == null) { + resultColumns = new ArrayList(); + } + return resultColumns; + } + + public void setResultColumns(List resultColumns) { + this.resultColumns = resultColumns; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/SearchTypeInfo.java b/sandbox/kss/wiki_to_java/transforms/SearchTypeInfo.java new file mode 100644 index 000000000..e8e0447a9 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/SearchTypeInfo.java @@ -0,0 +1,86 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class SearchTypeInfo Structure implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private String name; + + @XmlElement + private String desc; + + @XmlElement + private SearchResultTypeInfo searchResultTypeInfo; + + @XmlElement + private SearchCriteriaTypeInfo searchCriteriaTypeInfo; + + @XmlAttribute + private String key; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public SearchResultTypeInfo getSearchResultTypeInfo() { + return searchResultTypeInfo; + } + + public void setSearchResultTypeInfo(SearchResultTypeInfo searchResultTypeInfo) { + this.searchResultTypeInfo = searchResultTypeInfo; + } + + public SearchCriteriaTypeInfo getSearchCriteriaTypeInfo() { + return searchCriteriaTypeInfo; + } + + public void setSearchCriteriaTypeInfo(SearchCriteriaTypeInfo searchCriteriaTypeInfo) { + this.searchCriteriaTypeInfo = searchCriteriaTypeInfo; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/StateSelector.java b/sandbox/kss/wiki_to_java/transforms/StateSelector.java new file mode 100644 index 000000000..0a11c8209 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/StateSelector.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class StateSelector implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private FieldSelector field; + + @XmlAttribute + private String key; + + public FieldSelector getField() { + return field; + } + + public void setField(FieldSelector field) { + this.field = field; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/Status.java b/sandbox/kss/wiki_to_java/transforms/Status.java new file mode 100644 index 000000000..cc723c9c2 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/Status.java @@ -0,0 +1,42 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class Status implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private Boolean success; + + public Boolean getSuccess() { + return success; + } + + public void setSuccess(Boolean success) { + this.success = success; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/TypeSelector.java b/sandbox/kss/wiki_to_java/transforms/TypeSelector.java new file mode 100644 index 000000000..bb289192b --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/TypeSelector.java @@ -0,0 +1,53 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Date; +import java.util.List; + +import javax.xml.bind.annotation.XmlAccessType; +import javax.xml.bind.annotation.XmlAccessorType; +import javax.xml.bind.annotation.XmlAttribute; +import javax.xml.bind.annotation.XmlElement; + +@XmlAccessorType(XmlAccessType.FIELD) +public class TypeSelector implements Serializable { + + private static final long serialVersionUID = 1L; + + @XmlElement + private StateSelector state; + + @XmlAttribute + private String key; + + public StateSelector getState() { + return state; + } + + public void setState(StateSelector state) { + this.state = state; + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/foo.java b/sandbox/kss/wiki_to_java/transforms/foo.java new file mode 100644 index 000000000..f64e875b5 --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/foo.java @@ -0,0 +1,29 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + public interface foo { + /** + * Retrieves the list of communication media types that are supported for a given usage type. + * @param commUsageTypeKey usage type identifier + * @return list of communication media type information + * @throws DoesNotExistException commUsageTypeKey not found + * @throws InvalidParameterException invalid commUsageTypeKey + * @throws MissingParameterException missing commUsageTypeKey + * @throws OperationFailedException unable to complete request + */ + public List getCommMediaTypesForUsageType(@WebParam(name="commUsageTypeKey")String commUsageTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + +} \ No newline at end of file diff --git a/sandbox/kss/wiki_to_java/transforms/~foo.java b/sandbox/kss/wiki_to_java/transforms/~foo.java new file mode 100644 index 000000000..d9cf1f2bb --- /dev/null +++ b/sandbox/kss/wiki_to_java/transforms/~foo.java @@ -0,0 +1,282 @@ +/* + * Copyright 2008 The Kuali Foundation + * + * Licensed under the Educational Community License, Version 1.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.opensource.org/licenses/ecl1.php + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + public interface foo { + /** + * Retrieves the list of object type identifiers known by this service. Example: cluInfo. + * @return list of object type identifiers + * @throws OperationFailedException unable to complete request + */ + public List findObjectTypes() throws OperationFailedException; + + /** + * Retrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc. + * @param objectTypeKey identifier of the object type + * @return describes the fields for the input object type + * @throws DoesNotExistException specified objectTypeKey not found + * @throws InvalidParameterException invalid objectTypeKey + * @throws MissingParameterException missing objectTypeKey + * @throws OperationFailedException unable to complete request + */ + public ObjectStructure fetchObjectStructure(@WebParam(name="objectTypeKey")String objectTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + + /** + * Retrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality. + * @param enumerationKey identifier of the enumeration + * @param contextType identifier of the enumeration context type + * @param contextValue value of the enumeration context + * @param contextDate date and time to get the enumeration for + * @return list of enumerated codes and values + * @throws DoesNotExistException enumerationKey not found + * @throws InvalidParameterException invalid enumerationKey, contextType, contextValue, contextDate + * @throws MissingParameterException missing enumerationKey, contextType, contextValue, contextDate + * @throws OperationFailedException unable to complete request + */ + public List fetchEnumeration(@WebParam(name="enumerationKey")String enumerationKey, @WebParam(name="contextType")String contextType, @WebParam(name="contextValue")String contextValue, @WebParam(name="contextDate")Date contextDate) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + + /** + * Retrieves the list of search types known by this service. + * @return list of search type information + * @throws OperationFailedException unable to complete request + */ + public List findSearchTypes() throws OperationFailedException; + + /** + * Retrieves information about a particular search type. + * @param searchTypeKey identifier of the search type + * @return information on the search type + * @throws DoesNotExistException specified searchTypeKey not found + * @throws InvalidParameterException invalid searchTypeKey + * @throws MissingParameterException searchTypeKey not specified + * @throws OperationFailedException unable to complete request + */ + public SearchTypeInfo fetchSearchType(@WebParam(name="searchTypeKey")String searchTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + + /** + * Retrieves the list of search types which return results in the specified format. + * @param searchResultTypeKey identifier of the search result type + * @return list of search type information + * @throws DoesNotExistException specified searchResultTypeKey not found + * @throws InvalidParameterException invalid searchResultTypeKey + * @throws MissingParameterException searchResultTypeKey not specified + * @throws OperationFailedException unable to complete request + */ + public List findSearchTypesByResult(@WebParam(name="searchResultTypeKey")String searchResultTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + + /** + * Retrieves the list of search types which use criteria in the specified format. + * @param searchCriteriaTypeKey identifier of the search criteria + * @return list of search type information + * @throws DoesNotExistException specified searchCriteriaTypeKey not found + * @throws InvalidParameterException invalid searchCriteriaTypeKey + * @throws MissingParameterException searchCriteriaTypeKey not specified + * @throws OperationFailedException unable to complete request + */ + public List findSearchTypesByCriteria(@WebParam(name="searchCriteriaTypeKey")String searchCriteriaTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + + /** + * Retrieves the list of search result types known by this service. Search result types describe the return structure for a search. + * @return list of search result type information + * @throws OperationFailedException unable to complete request + */ + public List findSearchResultTypes() throws OperationFailedException; + + /** + * Retrieves information about a particular search result type. Search result types describe the return structure for a search. + * @param searchResultTypeKey identifier of the search result type + * @return information on the search result type + * @throws DoesNotExistException specified searchResultTypeKey not found + * @throws InvalidParameterException invalid searchResultTypeKey + * @throws MissingParameterException searchResultTypeKey not specified + * @throws OperationFailedException unable to complete request + */ + public SearchResultTypeInfo fetchSearchResultType(@WebParam(name="searchResultTypeKey")String searchResultTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + + /** + * Retrieves the list of search criteria types known by this service. + * @return list of search criteria type information + * @throws OperationFailedException unable to complete request + */ + public List findSearchCriteriaTypes() throws OperationFailedException; + + /** + * Retrieves information about a particular search criteria type. + * @param searchCriteriaTypeKey identifier of the search criteria type + * @return information on the search criteria type + * @throws DoesNotExistException specified searchCriteriaTypeKey not found + * @throws InvalidParameterException invalid searchCriteriaTypeKey + * @throws MissingParameterException searchCriteriaTypeKey not specified + * @throws OperationFailedException unable to complete request + */ + public SearchCriteriaTypeInfo fetchSearchCriteriaType(@WebParam(name="searchCriteriaTypeKey")String searchCriteriaTypeKey) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException; + + /** + * Retrieve the list of authentication types known by this service + * @return list of authentication types + * @throws OperationFailedException unable to complete request + */ + public List findAuthenticationTypes() throws OperationFailedException; + + /** + * Retrieves a list of Principals for a given Person + * @param personId person identifier + * @return list of principal ids for the specified person + * @throws DisabledIdentifierException personId found but has been retired + * @throws DoesNotExistException personId not found + * @throws InvalidParameterException invalid personId + * @throws MissingParameterException missing personId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public List findPrincipalIdsByPerson(@WebParam(name="personId")String personId) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Retrieves a list of Principals for a given System + * @param systemId system identifier + * @return list of principal ids for the given system + * @throws DisabledIdentifierException systemId found but has been retired + * @throws DoesNotExistException systemId not found + * @throws InvalidParameterException invalid systemId + * @throws MissingParameterException missing systemId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public List findPrincipalIdsBySystem(@WebParam(name="systemId")String systemId) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Retrieves a Person for a given Principal + * @param principalId principal identifier + * @return person identifier that matches the supplied criteria + * @throws DisabledIdentifierException principalId found but has been retired + * @throws DoesNotExistException principalId not found + * @throws InvalidParameterException invalid principalId + * @throws MissingParameterException missing principalId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public String fetchPersonIdByPrincipal(@WebParam(name="principalId")String principalId) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Retrieves a System for a given Principal + * @param principalId principal identifier + * @return system identifier that matches the supplied criteria + * @throws DisabledIdentifierException systemId found but has been retired + * @throws DoesNotExistException systemId not found + * @throws InvalidParameterException invalid principalId + * @throws MissingParameterException missing principalId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public String fetchSystemByPrincipal(@WebParam(name="principalId")String principalId) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Retrieves a Principal Type for a given Principal + * @param principalId principal identifier + * @return principal type that matches the supplied criteria + * @throws DisabledIdentifierException principalId found but has been retired + * @throws DoesNotExistException principalId not found + * @throws InvalidParameterException invalid principalId + * @throws MissingParameterException missing principalId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public PrincipalType fetchPrincipalTypeForPrincipal(@WebParam(name="principalId")String principalId) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Retrieves a list of Principal Types for a given list of Principal Ids + * @param principalIdList list of principal identifiers + * @return List of principal types that match the supplied criteria + * @throws DisabledIdentifierException One or more principalIds found but have been retired + * @throws DoesNotExistException One or more principalIds not found + * @throws InvalidParameterException invalid principalIdList + * @throws MissingParameterException missing principalId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public List findPrincipalTypesByPrincipalIdList(@WebParam(name="principalIdList")List principalIdList) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Retrieves results in tabular form for the specified parameters. + * @param searchTypeKey search identifier + * @param queryParamValues list of values for search parameters + * @return list of results from the query + * @throws DoesNotExistException specified search type not found + * @throws InvalidParameterException invalid searchTypeKey, queryParamValueList + * @throws MissingParameterException searchTypeKey, queryParamValueList not specified + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public List searchForResults(@WebParam(name="searchTypeKey")String searchTypeKey, @WebParam(name="queryParamValues")List queryParamValues) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Assigns a Principal to a Person + * @param principalId principal identifier + * @param personId person identifier + * @return status of the operation + * @throws AlreadyExistsException association already exists + * @throws DisabledIdentifierException personId or principalId found but has been retired + * @throws DoesNotExistException personId, principalId does not exist + * @throws InvalidParameterException invalid personId, principalId + * @throws MissingParameterException missing personId, principalId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public Status assignPrincipalToPerson(@WebParam(name="principalId")String principalId, @WebParam(name="personId")String personId) throws AlreadyExistsException, DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Assigns a Principal to a System + * @param principalId principal identifier + * @param systemId system identifier + * @return status of the operation + * @throws AlreadyExistsException association already exists + * @throws DisabledIdentifierException principalId, systemId found but has been retired + * @throws DoesNotExistException principalId, systemId does not exist + * @throws InvalidParameterException invalid principalId, systemId + * @throws MissingParameterException missing principalId, systemId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public Status assignPrincipalToSystem(@WebParam(name="principalId")String principalId, @WebParam(name="systemId")String systemId) throws AlreadyExistsException, DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Remove a Principal from a Person + * @param principalId principal identifier + * @param personId person identifier + * @return status of the operation + * @throws DisabledIdentifierException personId or principalId found but has been retired + * @throws DoesNotExistException personId, principalId, association does not exist + * @throws InvalidParameterException invalid personId, principalId + * @throws MissingParameterException missing personId, principalId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public Status removePrincipalFromPerson(@WebParam(name="principalId")String principalId, @WebParam(name="personId")String personId) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + + /** + * Remove a Principal from a System + * @param principalId principal identifier + * @param systemId system identifier + * @return status of the operation + * @throws DisabledIdentifierException principalId, systemId found but has been retired + * @throws DoesNotExistException principalId, systemId, association does not exist + * @throws InvalidParameterException invalid principalId, systemId + * @throws MissingParameterException missing principalId, systemId + * @throws OperationFailedException unable to complete request + * @throws PermissionDeniedException authorization failure + */ + public Status removePrincipalFromSystem(@WebParam(name="principalId")String principalId, @WebParam(name="systemId")String systemId) throws DisabledIdentifierException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException; + +} \ No newline at end of file