Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
X
xta-client-lib
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
OZG-Cloud
lib
xta-client-lib
Commits
5a281d49
Commit
5a281d49
authored
6 months ago
by
Jan Zickermann
Browse files
Options
Downloads
Patches
Plain Diff
OZG-6891 KOP-2735 xta-file: Add javadoc
parent
a87c1f6a
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/main/java/de/ozgcloud/xta/client/model/XtaFile.java
+26
-1
26 additions, 1 deletion
src/main/java/de/ozgcloud/xta/client/model/XtaFile.java
with
26 additions
and
1 deletion
src/main/java/de/ozgcloud/xta/client/model/XtaFile.java
+
26
−
1
View file @
5a281d49
...
...
@@ -10,6 +10,31 @@ import jakarta.validation.constraints.PositiveOrZero;
import
lombok.Builder
;
/**
* Represents a file in the XTA context.
*
* <p>
* <small>Parameter documentation strings translated from <i>XTA-Webservice-Datentypen.xsd</i>.</small>
* </p>
*
* @param content A data handler of the file content. <p>This field is required.</p>
* @param contentType This attribute specifies the MIME type of the contained content, so it includes entries like {@code text/xml},
* {@code text/plain}, {@code application/gzip}, or {@code application/pdf}. <p>This field is required as it is particularly
* important information (handled analogously in email).</p>
* @param contentDescription The description of the content, e.g., 'Offer' or 'Invoice'. <p>This field is optional.</p>
* @param encoding The character set that was used for encoding the content. <p>This field is optional.</p>
* @param name The filename of the data source, if the content was taken from a file. E.g.: For the transmission of xdomea messages,
* this attribute is mandatory. <p>This field is recommended as it is required for xdomea.</p>
* @param id Provides the ability to reference the content via, for example, a running number. <p>This field is optional and will be
* automatically set by the XTA server.</p>
* @param language Language of the file content, for instance, {@code en-US} or {@code de-DE}, see <a
* href="http://www.ietf.org/rfc/rfc3066.txt">RFC 3066</a>. <p>This field is optional.</p>
* @param size The size of the file content in bytes.
*
* <p>
* This field is optional and will be automatically set by the XTA server.
* </p>
*/
@Builder
(
toBuilder
=
true
)
public
record
XtaFile
(
@NotNull
DataHandler
content
,
...
...
@@ -19,6 +44,6 @@ public record XtaFile(
@NotBlank
String
name
,
@Nullable
String
id
,
@Nullable
String
language
,
@PositiveOrZero
BigInteger
size
@Nullable
@PositiveOrZero
BigInteger
size
)
{
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment